Skip navigation links

Oracle Communications Services Gatekeeper OAM Java API Reference
5.0

E21718-01


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


public interface DeviceCapabilitiesLdapMBean

Field Summary
static String authDN
          Authentication DN to connect to LDAP server.
static String authPassword
          Password to use authentication DN to connect to LDAP server.
static String baseDN
          To specify where we start LDAP lookup from directory.
static int connTimeout
          Specify LDAP connection timeout.
static String deviceIdAttributeName
          specify the device Id (e.g.
static String deviceNameAttributeName
          specify the device name of the specified subscriber.
static String deviceProfileURLAttributeName
          specify the device profile xml attribute name of the specified subscriber.
static String host
          specify the LDAP server host address.
static String ldapConnectionStatus
          Gets the LDAP connection status.
static int maxConnections
          Specify LDAP maximum connection in parallel.
static int minConnections
          Specify LDAP minimum connection in parallel.
static int port
          specify the LDAP server port.
static int recoverTimerInterval
          Specify the connection status watch-dog timer interval.
static String schema
          To specify the mapping rule from address to a LDAP query string.

 

Method Summary
 void apply()
          Update the device capabilities plug-in instance configuration according current values.
 String getAuthDN()
           
 String getAuthPassword()
           
 String getBaseDN()
           
 int getConnTimeout()
           
 String getDeviceIdAttributeName()
           
 String getDeviceNameAttributeName()
           
 String getDeviceProfileURLAttributeName()
           
 String getHost()
           
 String getLDAPConnectionStatus()
           
 int getMaxConnections()
           
 int getMinConnections()
           
 int getPort()
           
 int getRecoverTimerInterval()
           
 String getSchema()
           
 void setAuthDN(String authdn)
           
 void setAuthPassword(String authpassword)
           
 void setBaseDN(String bd)
           
 void setConnTimeout(int connTimeout)
           
 void setDeviceIdAttributeName(String name)
           
 void setDeviceNameAttributeName(String name)
           
 void setDeviceProfileURLAttributeName(String name)
           
 void setHost(String host)
           
 void setMaxConnections(int maxConnections)
           
 void setMinConnections(int minConnections)
           
 void setPort(int port)
           
 void setRecoverTimerInterval(int recoverTimeout)
           
 void setSchema(String schema)
           
 void updateSchemaURL(String schemaURL)
          Update schema from a url.

 

Field Detail

authDN

public static final String authDN
Authentication DN to connect to LDAP server.
See Also:
Constant Field Values

authPassword

public static final String authPassword
Password to use authentication DN to connect to LDAP server.
See Also:
Constant Field Values

baseDN

public static final String baseDN
To specify where we start LDAP lookup from directory.
See Also:
Constant Field Values

connTimeout

public static final int connTimeout
Specify LDAP connection timeout.
See Also:
Constant Field Values

deviceIdAttributeName

public static final String deviceIdAttributeName
specify the device Id (e.g. IMEI) of the specified subscriber.
See Also:
Constant Field Values

deviceNameAttributeName

public static final String deviceNameAttributeName
specify the device name of the specified subscriber.
See Also:
Constant Field Values

deviceProfileURLAttributeName

public static final String deviceProfileURLAttributeName
specify the device profile xml attribute name of the specified subscriber. i.e. The URL where the User Agent Profile XML file is located
See Also:
Constant Field Values

host

public static final String host
specify the LDAP server host address.
See Also:
Constant Field Values

ldapConnectionStatus

public static final String ldapConnectionStatus
Gets the LDAP connection status.
See Also:
Constant Field Values

maxConnections

public static final int maxConnections
Specify LDAP maximum connection in parallel.
See Also:
Constant Field Values

minConnections

public static final int minConnections
Specify LDAP minimum connection in parallel.
See Also:
Constant Field Values

port

public static final int port
specify the LDAP server port.
See Also:
Constant Field Values

recoverTimerInterval

public static final int recoverTimerInterval
Specify the connection status watch-dog timer interval. Please note once a connection status is kept stable for 3 times, the timer will be stopped.
See Also:
Constant Field Values

schema

public static final String schema
To specify the mapping rule from address to a LDAP query string.
See Also:
Constant Field Values

Method Detail

apply

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

getAuthDN

public String getAuthDN()

getAuthPassword

public String getAuthPassword()

getBaseDN

public String getBaseDN()

getConnTimeout

public int getConnTimeout()

getDeviceIdAttributeName

public String getDeviceIdAttributeName()

getDeviceNameAttributeName

public String getDeviceNameAttributeName()

getDeviceProfileURLAttributeName

public String getDeviceProfileURLAttributeName()

getHost

public String getHost()

getLDAPConnectionStatus

public String getLDAPConnectionStatus()

getMaxConnections

public int getMaxConnections()

getMinConnections

public int getMinConnections()

getPort

public int getPort()

getRecoverTimerInterval

public int getRecoverTimerInterval()

getSchema

public String getSchema()

setAuthDN

public void setAuthDN(String authdn)

setAuthPassword

public void setAuthPassword(String authpassword)

setBaseDN

public void setBaseDN(String bd)

setConnTimeout

public void setConnTimeout(int connTimeout)
                    throws InputManagementException
Throws:
InputManagementException

setDeviceIdAttributeName

public void setDeviceIdAttributeName(String name)

setDeviceNameAttributeName

public void setDeviceNameAttributeName(String name)

setDeviceProfileURLAttributeName

public void setDeviceProfileURLAttributeName(String name)

setHost

public void setHost(String host)

setMaxConnections

public void setMaxConnections(int maxConnections)

setMinConnections

public void setMinConnections(int minConnections)

setPort

public void setPort(int port)

setRecoverTimerInterval

public void setRecoverTimerInterval(int recoverTimeout)
                             throws InputManagementException
Throws:
InputManagementException

setSchema

public void setSchema(String schema)

updateSchemaURL

public void updateSchemaURL(String schemaURL)
                     throws InputManagementException
Update schema from a url. The url is like '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
5.0

E21718-01


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