com.vmware.content.library

Class PublishInfo

java.lang.Object

com.vmware.content.library.PublishInfo

All Implemented Interfaces:

StaticStructure, Structure, java.io.Serializable

public final class PublishInfo
extends java.lang.Object
implements java.io.Serializable, StaticStructure

The PublishInfo class defines how a local library is published publicly for synchronization to other libraries.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PublishInfo.AuthenticationMethod The AuthenticationMethod enumeration class indicates how a subscribed library should authenticate to the published library endpoint.
static class	PublishInfo.Builder Builder class for PublishInfo.

Field Summary

Fields

Modifier and Type	Field and Description
protected StructValue	__dynamicStructureFields

Constructor Summary

Constructors

Modifier	Constructor and Description
	PublishInfo() Default constructor.
protected	PublishInfo(StructValue __dynamicStructureFields)

Method Summary

Modifier and Type	Method and Description
<T extends Structure> T	_convertTo(java.lang.Class<T> clazz) Converts this structure into an instance of the provided class structure if possible.
java.lang.String	_getCanonicalName() Returns the canonical name of the structure.
static java.lang.String	_getCanonicalTypeName() Returns the canonical type name.
static com.vmware.vapi.bindings.type.StructType	_getClassType() WARNING: Internal method, subject to change in future versions.
StructValue	_getDataValue() Returns this Structure represented in the dynamic DataValue model.
DataValue	_getDynamicField(java.lang.String fieldName) Get dynamic filed value.
java.util.Set<java.lang.String>	_getDynamicFieldNames() Get the names of the dynamic fields in the structure.
com.vmware.vapi.bindings.type.StructType	_getType() WARNING: Internal method, subject to change in future versions.
boolean	_hasTypeNameOf(java.lang.Class<? extends Structure> clazz) Checks if the runtime type name of this structure matches the type represented by the specified binding class.
static PublishInfo	_newInstance(StructValue structValue) WARNING: Internal method, subject to change in future versions. Returns new instance of this binding class and injects the provided data value. WARNING: The returned object is not fully initialized.
static PublishInfo	_newInstance2(StructValue structValue) WARNING: Internal method, subject to change in future versions. Serves as a versioning mechanism.
void	_setDynamicField(java.lang.String fieldName, DataValue fieldValue) Sets a dynamic field value.
protected void	_updateDataValue(StructValue structValue)
void	_validate() Validates the state of the discriminated unions and HasFieldsOf restrictions (if any) in this Java language binding Structure.
boolean	equals(java.lang.Object obj)
PublishInfo.AuthenticationMethod	getAuthenticationMethod() Indicates how a subscribed library should authenticate (BASIC, NONE) to the published library endpoint.
char[]	getCurrentPassword() The current password to verify.
char[]	getPassword() The new password to require for authentication.
java.lang.Boolean	getPersistJsonEnabled() Whether library and library item metadata are persisted in the storage backing as JSON files.
java.lang.Boolean	getPublished() Whether the local library is published.
java.net.URI	getPublishUrl() The URL to which the library metadata is published by the Content Library Service.
java.lang.String	getUserName() The username to require for authentication.
int	hashCode()
void	setAuthenticationMethod(PublishInfo.AuthenticationMethod authenticationMethod) Indicates how a subscribed library should authenticate (BASIC, NONE) to the published library endpoint.
void	setCurrentPassword(char[] currentPassword) The current password to verify.
void	setPassword(char[] password) The new password to require for authentication.
void	setPersistJsonEnabled(java.lang.Boolean persistJsonEnabled) Whether library and library item metadata are persisted in the storage backing as JSON files.
void	setPublished(java.lang.Boolean published) Whether the local library is published.
void	setPublishUrl(java.net.URI publishUrl) The URL to which the library metadata is published by the Content Library Service.
void	setUserName(java.lang.String userName) The username to require for authentication.
java.lang.String	toString() Returns a string representation of this structure.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

__dynamicStructureFields

protected StructValue __dynamicStructureFields

Constructor Detail

PublishInfo

public PublishInfo()

Default constructor.

PublishInfo

protected PublishInfo(StructValue __dynamicStructureFields)

Method Detail

getAuthenticationMethod

public PublishInfo.AuthenticationMethod getAuthenticationMethod()

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 getCurrentPassword() property is required. This property will always be present in the results of the LocalLibrary.get(java.lang.String) method.

Returns:

The current value of the property.

setAuthenticationMethod

public void 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 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.

getPublished

public java.lang.Boolean getPublished()

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

Returns:

The current value of the property.

setPublished

public void 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 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.

getPublishUrl

public java.net.URI getPublishUrl()

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.

Returns:

The current value of the property.

setPublishUrl

public void 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.

getUserName

public java.lang.String getUserName()

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

Returns:

The current value of the property.

setUserName

public void 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.

getPassword

public char[] getPassword()

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 getCurrentPassword() property is required. This property is not used for the LocalLibrary.get(java.lang.String) method.

Returns:

The current value of the property.

setPassword

public void 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 getCurrentPassword() property is required. This property is not used for the LocalLibrary.get(java.lang.String) method.

Parameters:

password - New value for the property.

getCurrentPassword

public char[] getCurrentPassword()

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 getPassword(), turning off authentication, or unpublishing the library. This property is not used for the LocalLibrary.get(java.lang.String) method.

Returns:

The current value of the property.

setCurrentPassword

public void 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 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.

getPersistJsonEnabled

public java.lang.Boolean getPersistJsonEnabled()

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.

Returns:

The current value of the property.

setPersistJsonEnabled

public void 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.

_getType

public com.vmware.vapi.bindings.type.StructType _getType()

Description copied from interface: StaticStructure

WARNING: Internal method, subject to change in future versions. Returns StructType instance representing the static bindings type for this Structure.

Specified by:

_getType in interface StaticStructure

Returns:

the static bindings StructType

_getDataValue

public StructValue _getDataValue()

Description copied from interface: Structure

Returns this Structure represented in the dynamic DataValue model.

Attempts to change the returned StructValue representation are not required to change the state of this structure. Actually the behavior is implementation dependent and is unspecified. In general the returned value shouldn't be changed.

Specified by:

_getDataValue in interface Structure

Returns:

StructValue representing this structure

_updateDataValue

protected void _updateDataValue(StructValue structValue)

_validate

public void _validate()

Description copied from interface: StaticStructure

Validates the state of the discriminated unions and HasFieldsOf restrictions (if any) in this Java language binding Structure.

More precisely, for each union: given value of the discriminant/tag field (@UnionTag in the IDL) of an union in this structure, validates that:

all fields of the union required for that value of the discriminant are set fields of the union that are not allowed for that value of the discriminant are not set any other fields of the structure (not participating in the union) do not affect the validation result

Specified by:

_validate in interface StaticStructure

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Description copied from interface: StaticStructure

Returns a string representation of this structure. The result is pretty printed in order to be easy to read. It is intended to be used for different debugging/tracing purposes, e.g. dumping structures into logging traces.

In general no code should depend on the format of the resulting string. E.g. there must be no attempts to parse for re-creation of the original instance.

Specified by:

toString in interface StaticStructure

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this static structure instance

_hasTypeNameOf

public boolean _hasTypeNameOf(java.lang.Class<? extends Structure> clazz)

Description copied from interface: Structure

Checks if the runtime type name of this structure matches the type represented by the specified binding class.

This can be used as efficient check to determine if this instance can be successfully converted to the target type.

Specified by:

_hasTypeNameOf in interface Structure

Parameters:

clazz - bindings class for the target structure; must not be null

Returns:

true if this structures type name matches exactly the specified class' type name.

_convertTo

public <T extends Structure> T _convertTo(java.lang.Class<T> clazz)

Description copied from interface: Structure

Converts this structure into an instance of the provided class structure if possible. A conversion will be possible if the requested structure's fields are all present in this structure.

Specified by:

_convertTo in interface Structure

Parameters:

clazz - type of the result structure. cannot be null.

Returns:

an instance of the requested type if conversion is possible. CoreException is thrown otherwise.

_setDynamicField

public void _setDynamicField(java.lang.String fieldName,
                             DataValue fieldValue)

Description copied from interface: StaticStructure

Sets a dynamic field value. The dynamic filed is extra filed that is not part of the static fields of the structure.

Specified by:

_setDynamicField in interface StaticStructure

Parameters:

fieldName - canonical name of the dynamic field to set

fieldValue - the value of the field

_getDynamicField

public DataValue _getDynamicField(java.lang.String fieldName)

Description copied from interface: StaticStructure

Get dynamic filed value. Works only on dynamic fields.

Specified by:

_getDynamicField in interface StaticStructure

Parameters:

fieldName - the canonical name of the dynamic field

Returns:

the DataValue of the dynamic field

_getDynamicFieldNames

public java.util.Set<java.lang.String> _getDynamicFieldNames()

Description copied from interface: StaticStructure

Get the names of the dynamic fields in the structure.

Specified by:

_getDynamicFieldNames in interface StaticStructure

Returns:

set of the canonical field names for the dynamic fields

_getClassType

public static com.vmware.vapi.bindings.type.StructType _getClassType()

WARNING: Internal method, subject to change in future versions.

Returns:

StructType instance representing the static bindings type for this Structure.

_getCanonicalName

public java.lang.String _getCanonicalName()

Description copied from interface: Structure

Returns the canonical name of the structure. By default the canonical name is derived from the fully-qualified IDL name by converting to lower case and inserting underscores between words. For example org.example.FooBar would turn into org.example.foo_bar.

Specified by:

_getCanonicalName in interface Structure

Returns:

canonical name

_getCanonicalTypeName

public static java.lang.String _getCanonicalTypeName()

Returns the canonical type name. See _getCanonicalName().

Returns:

canonical type name

_newInstance

public static PublishInfo _newInstance(StructValue structValue)

WARNING: Internal method, subject to change in future versions.
Returns new instance of this binding class and injects the provided data value.
WARNING: The returned object is not fully initialized.

Parameters:

structValue - the source of the data contained in the binding object. Could contain more data than fields of this class can describe i.e. newer version of the binding object. Could be null.

Returns:

the static bindings StructType

_newInstance2

public static PublishInfo _newInstance2(StructValue structValue)

WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism.