Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKLSConfigurationMgmtICM

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.dkAbstractConfigurationMgmt
        |
        +--com.ibm.mm.sdk.common.DKLSConfigurationMgmtICM
All Implemented Interfaces:
dkConfigurationMgmt, DKConstant, DKConstantICM, DKMessageId, DKMessageIdICM, java.io.Serializable

public class DKLSConfigurationMgmtICM
extends dkAbstractConfigurationMgmt
implements DKMessageIdICM, DKConstantICM, java.io.Serializable

This class provides the functions to retrieve and update the Library Server Configuration parameters. It also provides a function for generating a new encryption key.

See Also:
Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKMessageIdICM
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKConstantICM
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKConstant
    For details, see the class or interface
 
Constructor Summary
DKLSConfigurationMgmtICM(dkDatastore ds)
          Constructs an new DKLSConfigurationMgmtICM object and initialize with the datastore object whose configuration is to be managed.
 
Method Summary
 void defineConfigParameters(DKLSCfgDefICM configParms)
          Updates the current Library Server Configuration parameters.
 void keyFlush()
          Generates a new encryption key for Library Server The purpose of this method is to generate a new encryption key used by the Library Server to generate access tokens and will be used by all Resource Managers to verify tokens.
 DKLSCfgDefICM retrieveConfigParameters()
          Retrieves the current Library Server Configuration parameters.
 
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractConfigurationMgmt
clearCache, getDatastore, setDatastore
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKLSConfigurationMgmtICM

public DKLSConfigurationMgmtICM(dkDatastore ds)
                         throws DKException,
                                java.lang.Exception
Constructs an new DKLSConfigurationMgmtICM object and initialize with the datastore object whose configuration is to be managed.
Parameters:
ds - - a datastore object whose configuration is to be managed.
Throws:
DKException - if a problem is encountered
Method Detail

retrieveConfigParameters

public DKLSCfgDefICM retrieveConfigParameters()
                                       throws DKException,
                                              java.lang.Exception
Retrieves the current Library Server Configuration parameters.
Returns:
a DKLSCfgDefICM object containing the current configuration parameters.
Throws:
DKException - if a problem is encountered

defineConfigParameters

public void defineConfigParameters(DKLSCfgDefICM configParms)
                            throws DKException,
                                   java.lang.Exception
Updates the current Library Server Configuration parameters. The update of the Library Server Configuration will take effect immediately after the call.
Parameters:
configParms - a DKLSCfgDefICM object containing the configuration parameters
Throws:
DKException - if a problem is encountered

keyFlush

public void keyFlush()
              throws DKException,
                     java.lang.Exception
Generates a new encryption key for Library Server The purpose of this method is to generate a new encryption key used by the Library Server to generate access tokens and will be used by all Resource Managers to verify tokens. In case of a security problem, this method can be invoked to generate a new encryption key. This would be done infrequently and will cause any outstanding unexpired access control tokens to become invalid.

NOTE: Transaction Manager is not applicable to this method.

Throws:
DKException - if a problem is encountered

EIP Java APIs

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.