Skip navigation links

Oracle Communications Services Gatekeeper OAM Java API Reference
5.1

E37524-01


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


public interface DeviceCapabilitiesLdapMBean

Device CapabilitiesLdap MBean.


Method Summary
 void apply()
          Update the device capabilities plug-in instance configuration according current values.
 String getAuthDN()
          get AuthDN.
 String getAuthPassword()
          get AuthPassword.
 String getBaseDN()
          get BaseDN.
 int getConnTimeout()
          get ConnTimeout.
 String getDeviceIdAttributeName()
          get DeviceIdAttributeName.
 String getDeviceNameAttributeName()
          get Device Name Attribute Name.
 String getDeviceProfileURLAttributeName()
          get Device Profile URL AttributeName.
 String getHost()
          get Host.
 String getLDAPConnectionStatus()
          get LDAPConnectionStatus.
 int getMaxConnections()
          get MaxConnections.
 int getMinConnections()
          get MinConnections.
 int getPort()
          get Port.
 int getRecoverTimerInterval()
          get RecoverTimerInterval.
 String getSchema()
          get Schema.
 void setAuthDN(String authdn)
          se tAuthDN.
 void setAuthPassword(String authpassword)
          set AuthPassword.
 void setBaseDN(String bd)
          set BaseDN.
 void setConnTimeout(int connTimeout)
          set ConnTimeout.
 void setDeviceIdAttributeName(String name)
          set DeviceIdAttributeName.
 void setDeviceNameAttributeName(String name)
          set Device Name Attribute Name.
 void setDeviceProfileURLAttributeName(String name)
          set DeviceProfile URL AttributeName.
 void setHost(String host)
          set Host.
 void setMaxConnections(int maxConnections)
          set MaxConnections.
 void setMinConnections(int minConnections)
          set MinConnections.
 void setPort(int port)
          set Port.
 void setRecoverTimerInterval(int recoverTimeout)
          set RecoverTimerInterval.
 void setSchema(String schema)
          set Schema.
 void updateSchemaURL(String schemaURL)
          Update schema from a url.

 

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()
get AuthDN.
Returns:
Authentication DN to connect to LDAP server.

getAuthPassword

public String getAuthPassword()
get AuthPassword.
Returns:
Password to use authentication DN to connect to LDAP server.

getBaseDN

public String getBaseDN()
get BaseDN.
Returns:
where we start LDAP lookup from directory.

getConnTimeout

public int getConnTimeout()
get ConnTimeout.
Returns:
connection timeout.

getDeviceIdAttributeName

public String getDeviceIdAttributeName()
get DeviceIdAttributeName.
Returns:
the device Id (e.g. IMEI) of the specified subscriber.

getDeviceNameAttributeName

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

getDeviceProfileURLAttributeName

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

getHost

public String getHost()
get Host.
Returns:
the LDAP server host address.

getLDAPConnectionStatus

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

getMaxConnections

public int getMaxConnections()
get MaxConnections.
Returns:
maximum connection in parallel.

getMinConnections

public int getMinConnections()
get MinConnections.
Returns:
minimum connection in parallel.

getPort

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

getRecoverTimerInterval

public int getRecoverTimerInterval()
get RecoverTimerInterval.
Returns:
connection status watch-dog timer interval.

getSchema

public String getSchema()
get Schema.
Returns:
the mapping rule from address to a LDAP query string.

setAuthDN

public void setAuthDN(String authdn)
se tAuthDN.
Parameters:
authdn - Authentication DN to connect to LDAP server.

setAuthPassword

public void setAuthPassword(String authpassword)
set AuthPassword.
Parameters:
authpassword - Password to use authentication DN to connect to LDAP server.

setBaseDN

public void setBaseDN(String bd)
set BaseDN.
Parameters:
bd - where we start LDAP lookup from directory.

setConnTimeout

public void setConnTimeout(int connTimeout)
                    throws InputManagementException
set ConnTimeout.
Parameters:
connTimeout - connection timeout.
Throws:
InputManagementException - InputManagementException

setDeviceIdAttributeName

public void setDeviceIdAttributeName(String name)
set DeviceIdAttributeName.
Parameters:
name - the device Id (e.g. IMEI) of the specified subscriber.

setDeviceNameAttributeName

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

setDeviceProfileURLAttributeName

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

setHost

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

setMaxConnections

public void setMaxConnections(int maxConnections)
set MaxConnections.
Parameters:
maxConnections - maximum connection in parallel.

setMinConnections

public void setMinConnections(int minConnections)
set MinConnections.
Parameters:
minConnections - minimum connection in parallel.

setPort

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

setRecoverTimerInterval

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

setSchema

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

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

E37524-01


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