com.sonicsw.mq.mgmtapi.config.gen
Interface IAbstractBrokerBean.IAbstractLdapConnectionType

All Superinterfaces:

IMgmtBase, IMgmtSubBeanBase

All Known Subinterfaces:

IBrokerBean.ILdapConnectionType

Enclosing interface:

IAbstractBrokerBean

public static interface IAbstractBrokerBean.IAbstractLdapConnectionType
extends IMgmtSubBeanBase

Inner class representing LdapConnectionType This class extends IMgmtListBase

Method Summary

IBrokerBean.IJsseParametersType	createLdapSslParameters() Create an instance of an IJsseParametersType attribute.
java.lang.String	getLdapAuthMechanism() Get the attribute for LDAP_AUTH_MECHANISM as a String value.
IMgmtAttributeMetaData	getLdapAuthMechanismMetaData() Get the attribute metadata for LDAP_AUTH_MECHANISM.
java.lang.String	getLdapServerPassword() Get the attribute for LDAP_SERVER_PASSWORD as a String value.
java.lang.String	getLdapServerPassword(java.lang.String defValue) Get the attribute for LDAP_SERVER_PASSWORD as a String value.
IMgmtAttributeMetaData	getLdapServerPasswordMetaData() Get the attribute metadata for LDAP_SERVER_PASSWORD.
java.lang.String	getLdapServerUrl() Get the attribute for LDAP_SERVER_URL as a String value.
java.lang.String	getLdapServerUrl(java.lang.String defValue) Get the attribute for LDAP_SERVER_URL as a String value.
IMgmtAttributeMetaData	getLdapServerUrlMetaData() Get the attribute metadata for LDAP_SERVER_URL.
java.lang.String	getLdapServerUser() Get the attribute for LDAP_SERVER_USER as a String value.
java.lang.String	getLdapServerUser(java.lang.String defValue) Get the attribute for LDAP_SERVER_USER as a String value.
IMgmtAttributeMetaData	getLdapServerUserMetaData() Get the attribute metadata for LDAP_SERVER_USER.
IBrokerBean.IJsseParametersType	getLdapSslParameters() Get the attribute for LDAP_SSL_PARAMETERS.
IMgmtAttributeMetaData	getLdapSslParametersMetaData() Get the attribute metadata for LDAP_SSL_PARAMETERS.
void	setLdapAuthMechanism(java.lang.String value) Set the attribute for LDAP_AUTH_MECHANISM to the specified String value.
void	setLdapServerPassword(java.lang.String value) Set the attribute for LDAP_SERVER_PASSWORD to the specified String value.
void	setLdapServerUrl(java.lang.String value) Set the attribute for LDAP_SERVER_URL to the specified String value.
void	setLdapServerUser(java.lang.String value) Set the attribute for LDAP_SERVER_USER to the specified String value.
void	setLdapSslParameters(IBrokerBean.IJsseParametersType value) Set the attribute for LDAP_SSL_PARAMETERS to the specified IJsseParametersType value.

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

getBigDecimalAttribute, getBooleanAttribute, getByteArrayAttribute, getIntegerAttribute, getLongAttribute, getReferenceAttribute, getStringAttribute, 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

Method Detail

createLdapSslParameters

IBrokerBean.IJsseParametersType createLdapSslParameters()
                                                        throws MgmtException

Create an instance of an IJsseParametersType 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 setLdapSslParameters method.

Returns:

The new IJsseParametersType bean

Throws:

MgmtException - Thrown if there is some problem creating this object

getLdapAuthMechanism

java.lang.String getLdapAuthMechanism()
                                      throws MgmtException

Get the attribute for LDAP_AUTH_MECHANISM 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

getLdapAuthMechanismMetaData

IMgmtAttributeMetaData getLdapAuthMechanismMetaData()
                                                    throws MgmtException

Get the attribute metadata for LDAP_AUTH_MECHANISM.

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

getLdapServerPassword

java.lang.String getLdapServerPassword()
                                       throws MgmtException

Get the attribute for LDAP_SERVER_PASSWORD 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

getLdapServerPassword

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

Get the attribute for LDAP_SERVER_PASSWORD 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

getLdapServerPasswordMetaData

IMgmtAttributeMetaData getLdapServerPasswordMetaData()
                                                     throws MgmtException

Get the attribute metadata for LDAP_SERVER_PASSWORD.

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

getLdapServerUrl

java.lang.String getLdapServerUrl()
                                  throws MgmtException

Get the attribute for LDAP_SERVER_URL 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

getLdapServerUrl

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

Get the attribute for LDAP_SERVER_URL 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

getLdapServerUrlMetaData

IMgmtAttributeMetaData getLdapServerUrlMetaData()
                                                throws MgmtException

Get the attribute metadata for LDAP_SERVER_URL.

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

getLdapServerUser

java.lang.String getLdapServerUser()
                                   throws MgmtException

Get the attribute for LDAP_SERVER_USER 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

getLdapServerUser

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

Get the attribute for LDAP_SERVER_USER 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

getLdapServerUserMetaData

IMgmtAttributeMetaData getLdapServerUserMetaData()
                                                 throws MgmtException

Get the attribute metadata for LDAP_SERVER_USER.

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

getLdapSslParameters

IBrokerBean.IJsseParametersType getLdapSslParameters()
                                                     throws MgmtException

Get the attribute for LDAP_SSL_PARAMETERS.

Returns:

The IJsseParametersType value for this attribute

Throws:

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

getLdapSslParametersMetaData

IMgmtAttributeMetaData getLdapSslParametersMetaData()
                                                    throws MgmtException

Get the attribute metadata for LDAP_SSL_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

setLdapAuthMechanism

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

Set the attribute for LDAP_AUTH_MECHANISM to the specified String value.

Parameters:

value - The String value for this attribute

Throws:

MgmtException - Thrown if there is some problem setting this attribute

setLdapServerPassword

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

Set the attribute for LDAP_SERVER_PASSWORD to the specified String value.

Parameters:

value - The String value for this attribute

Throws:

MgmtException - Thrown if there is some problem setting this attribute

setLdapServerUrl

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

Set the attribute for LDAP_SERVER_URL to the specified String value.

Parameters:

value - The String value for this attribute

Throws:

MgmtException - Thrown if there is some problem setting this attribute

setLdapServerUser

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

Set the attribute for LDAP_SERVER_USER to the specified String value.

Parameters:

value - The String value for this attribute

Throws:

MgmtException - Thrown if there is some problem setting this attribute

setLdapSslParameters

void setLdapSslParameters(IBrokerBean.IJsseParametersType value)
                          throws MgmtException

Set the attribute for LDAP_SSL_PARAMETERS to the specified IJsseParametersType value.

Parameters:

value - The IJsseParametersType value for this attribute

Throws:

MgmtException - Thrown if there is some problem setting this attribute