com.vmware.content.library

Class PublishInfo.Builder

java.lang.Object

com.vmware.content.library.PublishInfo.Builder

Enclosing class:

PublishInfo

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

Builder class for PublishInfo.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
PublishInfo	build()
PublishInfo.Builder	setAuthenticationMethod(PublishInfo.AuthenticationMethod authenticationMethod) Indicates how a subscribed library should authenticate (BASIC, NONE) to the published library endpoint.
PublishInfo.Builder	setCurrentPassword(char[] currentPassword) The current password to verify.
PublishInfo.Builder	setPassword(char[] password) The new password to require for authentication.
PublishInfo.Builder	setPersistJsonEnabled(java.lang.Boolean persistJsonEnabled) Whether library and library item metadata are persisted in the storage backing as JSON files.
PublishInfo.Builder	setPublished(java.lang.Boolean published) Whether the local library is published.
PublishInfo.Builder	setPublishUrl(java.net.URI publishUrl) The URL to which the library metadata is published by the Content Library Service.
PublishInfo.Builder	setUserName(java.lang.String userName) The username to require for authentication.

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 PublishInfo.

Method Detail

setAuthenticationMethod

public PublishInfo.Builder setAuthenticationMethod(PublishInfo.AuthenticationMethod authenticationMethod)

Indicates how a subscribed library should authenticate (BASIC, NONE) to the published library endpoint. This property is required for the LocalLibrary.create(java.lang.String, com.vmware.content.LibraryModel) method. It is optional for the LocalLibrary.update(java.lang.String, com.vmware.content.LibraryModel) operation, and if null the value will not be changed. When the existing authentication method is PublishInfo.AuthenticationMethod.BASIC and authentication is being turned off by updating this property to PublishInfo.AuthenticationMethod.NONE, then the PublishInfo.getCurrentPassword() property is required. This property will always be present in the results of the LocalLibrary.get(java.lang.String) method.

Parameters:

authenticationMethod - New value for the property.

setPublished

public PublishInfo.Builder setPublished(java.lang.Boolean published)

Whether the local library is published. This property is required for the LocalLibrary.create(java.lang.String, com.vmware.content.LibraryModel) method. It is optional for the LocalLibrary.update(java.lang.String, com.vmware.content.LibraryModel) operation, and if null the value will not be changed. When the existing authentication method is PublishInfo.AuthenticationMethod.BASIC and the local library is published, the PublishInfo.getCurrentPassword() property is required before turning off publishing. This property will always be present in the results of the LocalLibrary.get(java.lang.String) method.

Parameters:

published - New value for the property.

setPublishUrl

public PublishInfo.Builder setPublishUrl(java.net.URI publishUrl)

The URL to which the library metadata is published by the Content Library Service.

This value can be used to set the SubscriptionInfo.getSubscriptionUrl() property when creating a subscribed library.

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

Parameters:

publishUrl - New value for the property.

setUserName

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

The username to require for authentication. This property is optional for the LocalLibrary.create(java.lang.String, com.vmware.content.LibraryModel) and LocalLibrary.update(java.lang.String, com.vmware.content.LibraryModel) methods. When the authentication method is PublishInfo.AuthenticationMethod.NONE, the username can be left null. When the authentication method is PublishInfo.AuthenticationMethod.BASIC, the username is ignored in the current release. It defaults to "vcsp". It is preferable to leave this null. If specified, it must be set to "vcsp".

Parameters:

userName - New value for the property.

setPassword

public PublishInfo.Builder setPassword(char[] password)

The new password to require for authentication. This property is optional for the LocalLibrary.create(java.lang.String, com.vmware.content.LibraryModel) method. When the authentication method is PublishInfo.AuthenticationMethod.NONE, the password can be left null. When the authentication method is PublishInfo.AuthenticationMethod.BASIC, the password should be a non-empty string. This property is optional for the LocalLibrary.update(java.lang.String, com.vmware.content.LibraryModel) method. Leaving it null during update indicates that the password is not changed. When the password is changed, the PublishInfo.getCurrentPassword() property is required. This property is not used for the LocalLibrary.get(java.lang.String) method.

Parameters:

password - New value for the property.

setCurrentPassword

public PublishInfo.Builder setCurrentPassword(char[] currentPassword)

The current password to verify. This property is available starting in vSphere 6.7. This property is unused for the LocalLibrary.create(java.lang.String, com.vmware.content.LibraryModel) method. This property is optional for the LocalLibrary.update(java.lang.String, com.vmware.content.LibraryModel) method. When the existing authentication method is PublishInfo.AuthenticationMethod.NONE, the current password can be left null. When the existing authentication method is PublishInfo.AuthenticationMethod.BASIC, the current password is verified before applying the new PublishInfo.getPassword(), turning off authentication, or unpublishing the library. This property is not used for the LocalLibrary.get(java.lang.String) method.

Parameters:

currentPassword - New value for the property.

setPersistJsonEnabled

public PublishInfo.Builder setPersistJsonEnabled(java.lang.Boolean persistJsonEnabled)

Whether library and library item metadata are persisted in the storage backing as JSON files. This flag only applies if the local library is published.

Enabling JSON persistence allows you to synchronize a subscribed library manually instead of over HTTP. You copy the local library content and metadata to another storage backing manually and then create a subscribed library referencing the location of the library JSON file in the SubscriptionInfo.getSubscriptionUrl(). When the subscribed library's storage backing matches the subscription URL, files do not need to be copied to the subscribed library.

For a library backed by a datastore, the library JSON file will be stored at the path contentlib-{library_id}/lib.json on the datastore.

For a library backed by a remote file system, the library JSON file will be stored at {library_id}/lib.json in the remote file system path.

This property is optional 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:

persistJsonEnabled - New value for the property.

build

public PublishInfo build()