|
Oracle Communications Services Gatekeeper OAM Java API Reference 6.0 E55516-02 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
OSA Access MBean interface
Field Summary | |
static boolean |
ericssonAuthentication Enables authentication towards Ericsson NRG Parlay GW |
Method Summary | |
void |
activateMapping(int mappingId) Activate an existing mapping |
void |
addClient(String osaClientAppId, String clientKeyFile, String clientCertFile, String clientKeyPwd, String keystorePwd) Adds an OSA client. |
int |
addConnection(int gwId, String nsRef, String nsName, String initialRef, int priority) Adds a connection to an existing OSA gateway. |
int |
addConnectionIOR(int gwId, String ior, String ns, int priority) Adds a connection to an existing OSA gateway. |
int |
addGw(String name, String osaFwCert, int reAuthWaitTime, String keystorePwd) Adds an OSA gateway. |
int |
addMapping(String serviceProviderID, String applicationID, String serviceType, String osaClientAppId, String properties, String authType, String encryptionMethod, String signingAlgorithm, int gatewayId, boolean initConnection) Adds a client mapping. |
boolean |
getEricssonAuthentication() |
int[] |
listActiveMappings() Lists all active mappings. |
int[] |
listActiveMappingsForGw(int gwId) Lists the active client mappings for a specific gateway. |
GwDescr[] |
listGw() Lists the configured OSA gateways. |
ClientOsaMappingDescr[] |
listMappings() Lists the configured client mappings. |
void |
removeClient(String osaClientAppId, String keystorePwd) Removes an OSA client. |
void |
removeConnection(int gatewayId, int connectionId) Removes a connection from an OSA gateway. |
void |
removeGw(int id, String keystorePwd) Removes an OSA gateway. |
void |
removeMapping(int id) Removes a client mapping. |
void |
setEricssonAuthentication(boolean enabled) |
String |
setKeyStorePassword(String newPassword, String oldPassword) Set the password that protects the keystore. |
ActiveMappingDescr |
viewActiveMappingState(int mappingId) Displays the state of an active mapping. |
Field Detail |
public static final boolean ericssonAuthentication
Method Detail |
public void activateMapping(int mappingId) throws ManagementException
mappingId
- The id of the mapping.ManagementException
public void addClient(String osaClientAppId, String clientKeyFile, String clientCertFile, String clientKeyPwd, String keystorePwd) throws ManagementException
osaClientAppId
- The OSA client app id (and alias in keystore)clientKeyFile
- The client private key file.clientCertFile
- The client public certificate file.clientKeyPwd
- The password protecting the client key file.keystorePwd
- The password that protects the keystore.ManagementException
public int addConnection(int gwId, String nsRef, String nsName, String initialRef, int priority) throws ManagementException
gwId
- The id of the gateway to add connection to.nsRef
- File containing IOR to name service. (leave blank if connInfo.initialRef is specified)nsName
- The name of initial object in name service, e.g. parlay_initial. Use path syntax e.g. /parlay/fw/parlay_inital to specify recursive naming contexts. (leave blank if connInfo.initialRef is specified)initialRef
- File containing IOR to parlay intial object. (leave blank if connInfo.nsRef and connInfo.nsName is specified)priority
- int, priority of this connection. Should be unique across all connections. The smaller the number, the higher the priority.ManagementException
public int addConnectionIOR(int gwId, String ior, String ns, int priority) throws ManagementException
gwId
- The id of the gateway to add connection to.ior
- IOR string of either the NS or the initial objectns
- Name of initial object in name service (leave blank if IOR to the initial object is specified)priority
- int, priority of this connection. Should be unique across all connections. The smaller the number, the higher the priority.ManagementException
public int addGw(String name, String osaFwCert, int reAuthWaitTime, String keystorePwd) throws ManagementException
name
- Descriptive name of the gateway.osaFwCert
- The certificate file of the OSA gatewayreAuthWaitTime
- The time in seconds to wait before reattempting authentication and manager obtain if all connections are down.keystorePwd
- The password that protects the keystore.ManagementException
public int addMapping(String serviceProviderID, String applicationID, String serviceType, String osaClientAppId, String properties, String authType, String encryptionMethod, String signingAlgorithm, int gatewayId, boolean initConnection) throws ManagementException
serviceProviderID
- Service provider.applicationID
- ApplicationserviceType
- Service type.osaClientAppId
- The OSA application id.properties
- OSA service properties to use in lookup. The properties are specified as a space separated list in the following way: <propname1> <propval1> ... <propnameN> <propvalN>authType
- Authentication method, i.e. P_AUTHENTICATION or P_OSA_AUTHENTICATION. In case of P_AUTHENTICATION, no encryption or signing algorithm will be used.encryptionMethod
- Encryption method. Leave blank to use default value.signingAlgorithm
- Signing algoritm. Leave blank to use default value.gatewayId
- The id of the gateway to use.initConnection
- Indicates if the connection to OSA Gwy should be initialized immediately, i.e. authentication performed.ManagementException
public boolean getEricssonAuthentication() throws ManagementException
ManagementException
public int[] listActiveMappings() throws ManagementException
ManagementException
public int[] listActiveMappingsForGw(int gwId) throws ManagementException
gwId
- The id of the gateway.ManagementException
public GwDescr[] listGw() throws ManagementException
ManagementException
public ClientOsaMappingDescr[] listMappings() throws ManagementException
ManagementException
public void removeClient(String osaClientAppId, String keystorePwd) throws ManagementException
osaClientAppId
- The OSA client app id (and alias in keystore)keystorePwd
- The password that protects the keystore.ManagementException
public void removeConnection(int gatewayId, int connectionId) throws ManagementException
gatewayId
- The id of the gateway.connectionId
- The id of the connection.ManagementException
public void removeGw(int id, String keystorePwd) throws ManagementException
id
- The id of the gateway to remove.ManagementException
public void removeMapping(int id) throws ManagementException
id
- id of the mapping to remove.ManagementException
public void setEricssonAuthentication(boolean enabled) throws ManagementException
enabled
- Enabled flag.ManagementException
public String setKeyStorePassword(String newPassword, String oldPassword) throws ManagementException
newPassword
- The new password.oldPassword
- The old password.ManagementException
public ActiveMappingDescr viewActiveMappingState(int mappingId) throws ManagementException
mappingId
- The id of the mapping.ManagementException
|
Oracle Communications Services Gatekeeper OAM Java API Reference 6.0 E55516-02 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |