public static final class PublishInfo.Builder extends Object
PublishInfo
.Constructor and Description |
---|
PublishInfo.Builder()
Constructor with parameters for the required properties of
PublishInfo . |
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 |
setPassword(char[] password)
The password to require for authentication.
|
PublishInfo.Builder |
setPersistJsonEnabled(Boolean persistJsonEnabled)
Whether library and library item metadata are persisted in the storage backing
as JSON files.
|
PublishInfo.Builder |
setPublished(Boolean published)
Whether the local library is published.
|
PublishInfo.Builder |
setPublishUrl(URI publishUrl)
The URL to which the library metadata is published by the Content Library
Service.
|
PublishInfo.Builder |
setUserName(String userName)
The username to require for authentication.
|
public PublishInfo.Builder()
PublishInfo
.public PublishInfo.Builder setAuthenticationMethod(PublishInfo.AuthenticationMethod authenticationMethod)
create
method. It will always be
present in the return value of the get
or list
methods. It is
optional for the update
method.authenticationMethod
- New value for the property.public PublishInfo.Builder setPublished(Boolean published)
create
method. It will always be
present in the return value of the get
or list
methods. It is
optional for the update
method.published
- New value for the property.public PublishInfo.Builder setPublishUrl(URI publishUrl)
This value can be used to set the SubscriptionInfo.getSubscriptionUrl()
property when
creating a subscribed library.
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.publishUrl
- New value for the property.public PublishInfo.Builder setUserName(String userName)
create
and update
method. When
the authentication is not required, the username can be left null
. When
the authentication method is basic, the username is ignored in the current
release. It defaults to "vcsp". It is preferable to leave this unset. If
specified, it must be set to "vcsp".userName
- New value for the property.public PublishInfo.Builder setPassword(char[] password)
create
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 update
method. Leaving it null
during update indicates that the password is not
changed. This property is not used for the get
or list
method.password
- New value for the property.public PublishInfo.Builder setPersistJsonEnabled(Boolean persistJsonEnabled)
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 thecreate
method. It will always be
present in the return value of the get
or list
methods. It is
optional for the update
method.persistJsonEnabled
- New value for the property.public PublishInfo build()
Copyright © 2016. All Rights Reserved.