com.vmware.content.library

Class SubscriptionInfo.Builder

java.lang.Object

com.vmware.content.library.SubscriptionInfo.Builder

Enclosing class:

SubscriptionInfo

public static final class SubscriptionInfo.Builder
extends java.lang.Object

Builder class for SubscriptionInfo.

Constructor Summary

Constructors

Constructor and Description
Builder() Constructor with parameters for the required properties of SubscriptionInfo.

Method Summary

Modifier and Type	Method and Description
SubscriptionInfo	build()
SubscriptionInfo.Builder	setAuthenticationMethod(SubscriptionInfo.AuthenticationMethod authenticationMethod) Indicate how the subscribed library should authenticate (BASIC, NONE) with the published library endpoint.
SubscriptionInfo.Builder	setAutomaticSyncEnabled(java.lang.Boolean automaticSyncEnabled) Whether the library should participate in automatic library synchronization.
SubscriptionInfo.Builder	setOnDemand(java.lang.Boolean onDemand) Indicates whether a library item's content will be synchronized only on demand.
SubscriptionInfo.Builder	setPassword(char[] password) The password to use when authenticating.
SubscriptionInfo.Builder	setSourceInfo(SourceInfo sourceInfo) Information about the source published library.
SubscriptionInfo.Builder	setSslThumbprint(java.lang.String sslThumbprint) An optional SHA-1 hash of the SSL certificate for the remote endpoint.
SubscriptionInfo.Builder	setSubscriptionUrl(java.net.URI subscriptionUrl) The URL of the endpoint where the metadata for the remotely published library is being served.
SubscriptionInfo.Builder	setUserName(java.lang.String userName) The username to use when authenticating.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Constructor with parameters for the required properties of SubscriptionInfo.

Method Detail

setAuthenticationMethod

public SubscriptionInfo.Builder setAuthenticationMethod(SubscriptionInfo.AuthenticationMethod authenticationMethod)

Indicate how the subscribed library should authenticate (BASIC, NONE) with the published library endpoint. This property must be provided for the create method. It will always be present in the return value of the get or list methods. It is optional for the update method.

Parameters:

authenticationMethod - New value for the property.

setAutomaticSyncEnabled

public SubscriptionInfo.Builder setAutomaticSyncEnabled(java.lang.Boolean automaticSyncEnabled)

Whether the library should participate in automatic library synchronization. In order for automatic synchronization to happen, the global ConfigurationModel.getAutomaticSyncEnabled() option must also be true. The subscription is still active even when automatic synchronization is turned off, but synchronization is only activated with an explicit call to SubscribedLibrary.sync(java.lang.String) or SubscribedItem.sync(java.lang.String, boolean). In other words, manual synchronization is still available even when automatic synchronization is disabled. This property must be provided for the create method. It will always be present in the return value of the get or list methods. It is optional for the update method.

Parameters:

automaticSyncEnabled - New value for the property.

setOnDemand

public SubscriptionInfo.Builder setOnDemand(java.lang.Boolean onDemand)

Indicates whether a library item's content will be synchronized only on demand.

If this is set to true, then the library item's metadata will be synchronized but the item's content (its files) will not be synchronized. The Content Library Service will synchronize the content upon request only. This can cause the first use of the content to have a noticeable delay.

Items without synchronized content can be forcefully synchronized in advance using the SubscribedItem.sync(java.lang.String, boolean) call with forceSyncContent set to true. Once content has been synchronized, the content can removed with the SubscribedItem.evict(java.lang.String) call.

If this value is set to false, all content will be synchronized in advance.

This property must be provided for the create method. It will always be present in the return value of the get or list methods. It is optional for the update method.

Parameters:

onDemand - New value for the property.

setPassword

public SubscriptionInfo.Builder setPassword(char[] password)

The password to use when authenticating.

The password must be set when using a password-based authentication method; empty strings are not allowed.

This property is optional for the create method. It will not be present in the return value of the get or list methods. It is optional for the update method.

Parameters:

password - New value for the property.

setSslThumbprint

public SubscriptionInfo.Builder setSslThumbprint(java.lang.String sslThumbprint)

An optional SHA-1 hash of the SSL certificate for the remote endpoint.

If this value is defined the SSL certificate will be verified by comparing it to the SSL thumbprint. The SSL certificate must verify against the thumbprint. When specified, the standard certificate chain validation behavior is not used. The certificate chain is validated normally if this value is null.

This property is optional for the create method. It will not be present in the return value of the get or list methods. It is optional for the update method.

Parameters:

sslThumbprint - New value for the property.

setSubscriptionUrl

public SubscriptionInfo.Builder setSubscriptionUrl(java.net.URI subscriptionUrl)

The URL of the endpoint where the metadata for the remotely published library is being served.

This URL can be the PublishInfo.getPublishUrl() of the published library (for example, https://server/path/lib.json).

If the source content comes from a published library with PublishInfo.getPersistJsonEnabled(), the subscription URL can be a URL pointing to the library JSON file on a datastore or remote file system. The supported formats are:

vSphere 6.5

• ds:///vmfs/volumes/{uuid}/mylibrary/lib.json (for datastore)
• nfs://server/path/mylibrary/lib.json (for NFSv3 server on vCenter Server Appliance)
• nfs://server/path/mylibrary/lib.json?version=4 (for NFSv4 server on vCenter Server Appliance)
• smb://server/path/mylibrary/lib.json (for SMB server)

vSphere 6.0

• file://server/mylibrary/lib.json (for UNC server on vCenter Server for Windows)
• file:///path/mylibrary/lib.json (for local file system)

When you specify a DS subscription URL, the datastore must be on the same vCenter Server as the subscribed library. When you specify an NFS or SMB subscription URL, the StorageBacking.getStorageUri() of the subscribed library must be on the same remote file server and should share a common parent path with the subscription URL.

This property must be provided for the create method. It will always be present in the return value of the get or list methods. It is optional for the update method.

Parameters:

subscriptionUrl - New value for the property.

setUserName

public SubscriptionInfo.Builder setUserName(java.lang.String userName)

The username to use when authenticating.

The username must be set when using a password-based authentication method. Empty strings are allowed for usernames.

This property is optional for the create method. It is optional in the return value of the get or list methods. It is optional for the update method.

Parameters:

userName - New value for the property.

setSourceInfo

public SubscriptionInfo.Builder setSourceInfo(SourceInfo sourceInfo)

Information about the source published library. This property will be set for a subscribed library which is associated with a subscription of the published library. This property was added in vSphere API 6.7.2. This property is optional for the create method. It is optional in the return value of the get or list methods. It is optional for the update method.

Parameters:

sourceInfo - New value for the property.

build

public SubscriptionInfo build()