Skip navigation links

Oracle Communications Services Gatekeeper OAM Java API Reference
6.0

E55516-02


oracle.ocsg.plugin.dc.ldap.management
Interface DeviceCapabilitiesLdapMBean


public interface DeviceCapabilitiesLdapMBean

Device CapabilitiesLdap MBean.


Method Summary
 void apply()
          Updates the device capabilities plug-in instance configuration according to the current values.
 String getAuthDN()
          Gets the AuthDN.
 String getAuthPassword()
          Gets the AuthPassword.
 String getBaseDN()
          Gets the BaseDN.
 int getConnTimeout()
          Gets the ConnTimeout.
 String getDeviceIdAttributeName()
          Gets the DeviceIdAttributeName.
 String getDeviceNameAttributeName()
          Gets the Device Name Attribute Name.
 String getDeviceProfileURLAttributeName()
          gets the Device Profile URL AttributeName.
 String getHost()
          Gets the LDAP server host address.
 String getLDAPConnectionStatus()
          Gets the LDAPConnectionStatus.
 int getMaxConnections()
          get MaxConnections.
 int getMinConnections()
          Gets the MinConnections.
 int getPort()
          Gets the LDAP server port.
 int getRecoverTimerInterval()
          Gets the RecoverTimerInterval.
 String getSchema()
          Gets a Schema.
 void setAuthDN(String authdn)
          Sets the AuthDN.
 void setAuthPassword(String authpassword)
          Sets the AuthPassword.
 void setBaseDN(String bd)
          Sets the BaseDN.
 void setConnTimeout(int connTimeout)
          Sets the ConnTimeout.
 void setDeviceIdAttributeName(String name)
          Sets the DeviceIdAttributeName.
 void setDeviceNameAttributeName(String name)
          Sets the Device Name Attribute Name.
 void setDeviceProfileURLAttributeName(String name)
          Sets the DeviceProfile URL AttributeName.
 void setHost(String host)
          Sets the LDAP server host address.
 void setMaxConnections(int maxConnections)
          set MaxConnections.
 void setMinConnections(int minConnections)
          set MinConnections.
 void setPort(int port)
          Sets the LDAP server port.
 void setRecoverTimerInterval(int recoverTimeout)
          Sets the RecoverTimerInterval.
 void setSchema(String schema)
          Sets a Schema.
 void updateSchemaURL(String schemaURL)
          Updates schema from a URL in format 'file:///d:/schema.xml'.

 

Method Detail

apply

public void apply()
           throws ManagementException
Updates the device capabilities plug-in instance configuration according to the current values.
Throws:
ManagementException.
ManagementException

getAuthDN

public String getAuthDN()
Gets the AuthDN.
Returns:
Authentication DN to connect to LDAP server.

getAuthPassword

public String getAuthPassword()
Gets the AuthPassword.
Returns:
Password used to authenticate with the LDAP server.

getBaseDN

public String getBaseDN()
Gets the BaseDN.
Returns:
The base LDAP lookup directory.

getConnTimeout

public int getConnTimeout()
Gets the ConnTimeout.
Returns:
connection timeout.

getDeviceIdAttributeName

public String getDeviceIdAttributeName()
Gets the DeviceIdAttributeName.
Returns:
The device ID, for eample, the IMEI, of the specified subscriber.

getDeviceNameAttributeName

public String getDeviceNameAttributeName()
Gets the Device Name Attribute Name.
Returns:
The device name of the specified subscriber.

getDeviceProfileURLAttributeName

public String getDeviceProfileURLAttributeName()
gets the Device Profile URL AttributeName.
Returns:
The device profile XML attribute name of the specified subscriber.

getHost

public String getHost()
Gets the LDAP server host address.
Returns:
The LDAP server host address.

getLDAPConnectionStatus

public String getLDAPConnectionStatus()
Gets the LDAPConnectionStatus.
Returns:
the LDAP connection status.

getMaxConnections

public int getMaxConnections()
get MaxConnections.
Returns:
The maximum parallel LDAP connections.

getMinConnections

public int getMinConnections()
Gets the MinConnections.
Returns:
Minimum parallel LDAP connections.

getPort

public int getPort()
Gets the LDAP server port.
Returns:
the LDAP server port.

getRecoverTimerInterval

public int getRecoverTimerInterval()
Gets the RecoverTimerInterval.
Returns:
connection Watch-dog timer interval status.

getSchema

public String getSchema()
Gets a Schema.
Returns:
The mapping rule from an address to a LDAP query string.

setAuthDN

public void setAuthDN(String authdn)
Sets the AuthDN.
Parameters:
authdn - The Authentication DN to connect to LDAP server.

setAuthPassword

public void setAuthPassword(String authpassword)
Sets the AuthPassword.
Parameters:
authpassword - Password used to authenticate with the LDAP server.

setBaseDN

public void setBaseDN(String bd)
Sets the BaseDN.
Parameters:
bd - The Base LDAP lookup directory.

setConnTimeout

public void setConnTimeout(int connTimeout)
                    throws InputManagementException
Sets the ConnTimeout.
Parameters:
connTimeout - Connection timeout.
Throws:
InputManagementException

setDeviceIdAttributeName

public void setDeviceIdAttributeName(String name)
Sets the DeviceIdAttributeName.
Parameters:
name - The device ID, for eample, the IMEI, of the specified subscriber.

setDeviceNameAttributeName

public void setDeviceNameAttributeName(String name)
Sets the Device Name Attribute Name.
Parameters:
name - The device name of the specified subscriber.

setDeviceProfileURLAttributeName

public void setDeviceProfileURLAttributeName(String name)
Sets the DeviceProfile URL AttributeName.
Parameters:
name - The device profile XML attribute name of the specified subscriber.

setHost

public void setHost(String host)
Sets the LDAP server host address.
Parameters:
host - the LDAP server host address.

setMaxConnections

public void setMaxConnections(int maxConnections)
set MaxConnections.
Parameters:
maxConnections - The maximum parallel LDAP connections.

setMinConnections

public void setMinConnections(int minConnections)
set MinConnections.
Parameters:
minConnections - Minimum parallel LDAP connections.

setPort

public void setPort(int port)
Sets the LDAP server port.
Parameters:
port - the LDAP server port.

setRecoverTimerInterval

public void setRecoverTimerInterval(int recoverTimeout)
                             throws InputManagementException
Sets the RecoverTimerInterval.
Parameters:
recoverTimeout - Connection status watch-dog timer interval.
Throws:
InputManagementException.
InputManagementException

setSchema

public void setSchema(String schema)
Sets a Schema.
Parameters:
schema - The mapping rule from an address to a LDAP query string.

updateSchemaURL

public void updateSchemaURL(String schemaURL)
                     throws InputManagementException
Updates schema from a URL in format 'file:///d:/schema.xml'.
Parameters:
schemaURL - The schema URL.
Throws:
ManagementException - The management exception.
InputManagementException

Skip navigation links

Oracle Communications Services Gatekeeper OAM Java API Reference
6.0

E55516-02


Copyright © 2008, 2015, Oracle and/or its affiliates. All rights reserved.