com.sonicsw.mf.mgmtapi.config.gen
Interface IAbstractDirectoryServiceBean

All Superinterfaces:

com.sonicsw.mx.config.IAnnotationExtension, IMgmtBase, IMgmtBeanBase

All Known Subinterfaces:

IDirectoryServiceBean

public interface IAbstractDirectoryServiceBean
extends IMgmtBeanBase

Configuration Bean representing a 'DirectoryService'

Nested Class Summary

static interface	IAbstractDirectoryServiceBean.IAbstractDsReferencesType Inner class representing DsReferencesType This class extends IMgmtListBase
static interface	IAbstractDirectoryServiceBean.IAbstractReplicationParametersType Inner class representing ReplicationParametersType This class extends IMgmtListBase
static interface	IAbstractDirectoryServiceBean.IAbstractSslParametersType Inner class representing SslParametersType This class extends IMgmtListBase
static interface	IAbstractDirectoryServiceBean.IAbstractStorageType Inner class representing StorageType This class extends IMgmtListBase

Field Summary

Fields inherited from interface com.sonicsw.ma.mgmtapi.config.IMgmtBeanBase

C_VERSION_PROPERTY, CLASS_PROPERTY, P_VERSION_PROPERTY, TEMPLATE_PROPERTY, TYPE_PROPERTY

Fields inherited from interface com.sonicsw.mx.config.IAnnotationExtension

END_CDATA, START_CDATA, TOOL_ANNOTATION

Method Summary

IDirectoryServiceBean.IReplicationParametersType	createReplicationParameters() Create an instance of an IReplicationParametersType attribute.
java.lang.String	getClassname() Get the attribute for CLASSNAME as a String value.
IMgmtAttributeMetaData	getClassnameMetaData() Get the attribute metadata for CLASSNAME.
java.lang.String	getClasspath() Get the attribute for CLASSPATH as a String value.
java.lang.String	getClasspath(java.lang.String defValue) Get the attribute for CLASSPATH as a String value.
IMgmtAttributeMetaData	getClasspathMetaData() Get the attribute metadata for CLASSPATH.
IDirectoryServiceBean.IDsReferencesType	getConfigElementReferences() Get the attribute for CONFIG_ELEMENT_REFERENCES.
IMgmtAttributeMetaData	getConfigElementReferencesMetaData() Get the attribute metadata for CONFIG_ELEMENT_REFERENCES.
java.lang.String	getDomainName() Get the attribute for DOMAIN_NAME as a String value.
IMgmtAttributeMetaData	getDomainNameMetaData() Get the attribute metadata for DOMAIN_NAME.
IDirectoryServiceBean.IStorageType	getFileSystemStorage() Get the attribute for FILE_SYSTEM_STORAGE.
IMgmtAttributeMetaData	getFileSystemStorageMetaData() Get the attribute metadata for FILE_SYSTEM_STORAGE.
java.lang.String	getHostDirectory() Get the attribute for HOST_DIRECTORY as a String value.
IMgmtAttributeMetaData	getHostDirectoryMetaData() Get the attribute metadata for HOST_DIRECTORY.
IDirectoryServiceBean.IReplicationParametersType	getReplicationParameters() Get the attribute for REPLICATION_PARAMETERS.
IMgmtAttributeMetaData	getReplicationParametersMetaData() Get the attribute metadata for REPLICATION_PARAMETERS.
int	getTraceMask() Get the attribute for TRACE_MASK as a int value.
int	getTraceMask(int defValue) Get the attribute for TRACE_MASK as a int value.
IMgmtAttributeMetaData	getTraceMaskMetaData() Get the attribute metadata for TRACE_MASK.
void	setClasspath(java.lang.String value) Set the attribute for CLASSPATH to the specified String value.
void	setDomainName(java.lang.String value) Set the attribute for DOMAIN_NAME to the specified String value.
void	setHostDirectory(java.lang.String value) Set the attribute for HOST_DIRECTORY to the specified String value.
void	setReplicationParameters(IDirectoryServiceBean.IReplicationParametersType value) Set the attribute for REPLICATION_PARAMETERS to the specified IReplicationParametersType value.
void	setTraceMask(int value) Set the attribute for TRACE_MASK to the specified int value.

Methods inherited from interface com.sonicsw.ma.mgmtapi.config.IMgmtBeanBase

clone, createUniqueName, getBigDecimalAttribute, getBooleanAttribute, getByteArrayAttribute, getIntegerAttribute, getLongAttribute, getProperty, getReferenceAttribute, getStringAttribute, isNewBean, setBigDecimalAttribute, setBooleanAttribute, setByteArrayAttribute, setIntegerAttribute, setLongAttribute, setReferenceAttribute, setStringAttribute

Methods inherited from interface com.sonicsw.ma.mgmtapi.config.IMgmtBase

getAttributeList, getAttributeMap, getAttributeMetaData, getConfigBean, getConfigBeanName, getConfigBeanNameTail, getConfigPath, getConfigPath, getMgmtBeanFactory, getParent, removeAttribute, setAttribute

Methods inherited from interface com.sonicsw.mx.config.IAnnotationExtension

getAnnotation, setAnnotation

Method Detail

createReplicationParameters

IDirectoryServiceBean.IReplicationParametersType createReplicationParameters()
                                                                             throws MgmtException

Create an instance of an IReplicationParametersType attribute. This new instance is not currently part of the configuration. Once it has been configured it should be set into the configuration using the setReplicationParameters method.

Returns:

The new IReplicationParametersType bean

Throws:

MgmtException - Thrown if there is some problem creating this object

getClassname

java.lang.String getClassname()
                              throws MgmtException

Get the attribute for CLASSNAME as a String value.

Returns:

The String value for this attribute

Throws:

MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute

getClassnameMetaData

IMgmtAttributeMetaData getClassnameMetaData()
                                            throws MgmtException

Get the attribute metadata for CLASSNAME.

Returns:

The IMgmtAttributeMetaData value for this attribute

Throws:

MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute's metadata

getClasspath

java.lang.String getClasspath()
                              throws MgmtException

Get the attribute for CLASSPATH as a String value. This is an optional attribute and a MgmtException will be thrown if the attribute does not exist.

Returns:

The String value for this attribute

Throws:

MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute

getClasspath

java.lang.String getClasspath(java.lang.String defValue)
                              throws MgmtException

Get the attribute for CLASSPATH as a String value. If the attribute doesn't exist then return the specified default value.

Parameters:

defValue - The default value to return if this attribute doesn't exist

Returns:

The String value for this attribute

Throws:

MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute

getClasspathMetaData

IMgmtAttributeMetaData getClasspathMetaData()
                                            throws MgmtException

Get the attribute metadata for CLASSPATH.

Returns:

The IMgmtAttributeMetaData value for this attribute

Throws:

MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute's metadata

getConfigElementReferences

IDirectoryServiceBean.IDsReferencesType getConfigElementReferences()
                                                                   throws MgmtException

Get the attribute for CONFIG_ELEMENT_REFERENCES.

Returns:

The IDsReferencesType value for this attribute

Throws:

MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute

getConfigElementReferencesMetaData

IMgmtAttributeMetaData getConfigElementReferencesMetaData()
                                                          throws MgmtException

Get the attribute metadata for CONFIG_ELEMENT_REFERENCES.

Returns:

The IMgmtAttributeMetaData value for this attribute

Throws:

MgmtException - Thrown when this attribute metadata doesn't exist or if there is some problem obtaining this attribute metadata

getDomainName

java.lang.String getDomainName()
                               throws MgmtException

Get the attribute for DOMAIN_NAME as a String value.

Returns:

The String value for this attribute

Throws:

MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute

getDomainNameMetaData

IMgmtAttributeMetaData getDomainNameMetaData()
                                             throws MgmtException

Get the attribute metadata for DOMAIN_NAME.

Returns:

The IMgmtAttributeMetaData value for this attribute

Throws:

MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute's metadata

getFileSystemStorage

IDirectoryServiceBean.IStorageType getFileSystemStorage()
                                                        throws MgmtException

Get the attribute for FILE_SYSTEM_STORAGE.

Returns:

The IStorageType value for this attribute

Throws:

MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute

getFileSystemStorageMetaData

IMgmtAttributeMetaData getFileSystemStorageMetaData()
                                                    throws MgmtException

Get the attribute metadata for FILE_SYSTEM_STORAGE.

Returns:

The IMgmtAttributeMetaData value for this attribute

Throws:

MgmtException - Thrown when this attribute metadata doesn't exist or if there is some problem obtaining this attribute metadata

getHostDirectory

java.lang.String getHostDirectory()
                                  throws MgmtException

Get the attribute for HOST_DIRECTORY as a String value.

Returns:

The String value for this attribute

Throws:

MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute

getHostDirectoryMetaData

IMgmtAttributeMetaData getHostDirectoryMetaData()
                                                throws MgmtException

Get the attribute metadata for HOST_DIRECTORY.

Returns:

The IMgmtAttributeMetaData value for this attribute

Throws:

MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute's metadata

getReplicationParameters

IDirectoryServiceBean.IReplicationParametersType getReplicationParameters()
                                                                          throws MgmtException

Get the attribute for REPLICATION_PARAMETERS.

Returns:

The IReplicationParametersType value for this attribute

Throws:

MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute

getReplicationParametersMetaData

IMgmtAttributeMetaData getReplicationParametersMetaData()
                                                        throws MgmtException

Get the attribute metadata for REPLICATION_PARAMETERS.

Returns:

The IMgmtAttributeMetaData value for this attribute

Throws:

MgmtException - Thrown when this attribute metadata doesn't exist or if there is some problem obtaining this attribute metadata

getTraceMask

int getTraceMask()
                 throws MgmtException

Get the attribute for TRACE_MASK as a int value. This is an optional attribute and a MgmtException will be thrown if the attribute does not exist.

Returns:

The int value for this attribute

Throws:

MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute

getTraceMask

int getTraceMask(int defValue)
                 throws MgmtException

Get the attribute for TRACE_MASK as a int value. If the attribute doesn't exist then return the specified default value.

Parameters:

defValue - The default value to return if this attribute doesn't exist

Returns:

The int value for this attribute

Throws:

MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute

getTraceMaskMetaData

IMgmtAttributeMetaData getTraceMaskMetaData()
                                            throws MgmtException

Get the attribute metadata for TRACE_MASK.

Returns:

The IMgmtAttributeMetaData value for this attribute

Throws:

MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute's metadata

setClasspath

void setClasspath(java.lang.String value)
                  throws MgmtException

Set the attribute for CLASSPATH to the specified String value.

Parameters:

value - The String value for this attribute

Throws:

MgmtException - Thrown if there is some problem setting this attribute

setDomainName

void setDomainName(java.lang.String value)
                   throws MgmtException

Set the attribute for DOMAIN_NAME to the specified String value.

Parameters:

value - The String value for this attribute

Throws:

MgmtException - Thrown if there is some problem setting this attribute

setHostDirectory

void setHostDirectory(java.lang.String value)
                      throws MgmtException

Set the attribute for HOST_DIRECTORY to the specified String value.

Parameters:

value - The String value for this attribute

Throws:

MgmtException - Thrown if there is some problem setting this attribute

setReplicationParameters

void setReplicationParameters(IDirectoryServiceBean.IReplicationParametersType value)
                              throws MgmtException

Set the attribute for REPLICATION_PARAMETERS to the specified IReplicationParametersType value.

Parameters:

value - The IReplicationParametersType value for this attribute

Throws:

MgmtException - Thrown if there is some problem setting this attribute

setTraceMask

void setTraceMask(int value)
                  throws MgmtException

Set the attribute for TRACE_MASK to the specified int value.

Parameters:

value - The int value for this attribute

Throws:

MgmtException - Thrown if there is some problem setting this attribute