Class CMS

java.lang.Object

com.netscape.cmscore.apps.CMS

public final class CMS
extends Object

This represents the CMS server. Plugins can access other public objects such as subsystems via this inteface. This object also include a set of utility functions.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIG_FILE
static final int	DEBUG_INFORM
static final int	DEBUG_OBNOXIOUS
static final int	DEBUG_VERBOSE
static final org.slf4j.Logger	logger
static final int	PRE_OP_MODE
static final int	RUNNING_MODE

Constructor Summary

Constructors

Constructor	Description
CMS()

Method Summary

Modifier and Type	Method	Description
static PasswordStore	createPasswordStore(PasswordStoreConfig psc)	Construct a password store.
static String	getInstanceDir()
static String	getInstanceID()
static String	getLogMessage(String msgID, Object... params)	Retrieves log message from LogMessages.properties or audit-events.properties.
static String	getProductName()	Return the product name from /usr/share/pki/CS_SERVER_VERSION which is provided by the server theme package.
static String	getProductVersion()
static String	getUserMessage(String msgID, String... params)	Retrieves the localized user message from UserMessages.properties.
static String	getUserMessage(Locale locale, String msgID, String... params)	Retrieves the localized user message from UserMessages.properties.
static boolean	isSensitive(String name)	Check whether the string is contains password

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

logger

public static final org.slf4j.Logger logger

DEBUG_OBNOXIOUS

public static final int DEBUG_OBNOXIOUS

See Also:

• Constant Field Values

DEBUG_VERBOSE

public static final int DEBUG_VERBOSE

See Also:

• Constant Field Values

DEBUG_INFORM

public static final int DEBUG_INFORM

See Also:

• Constant Field Values

CONFIG_FILE

public static final String CONFIG_FILE

See Also:

• Constant Field Values

PRE_OP_MODE

public static final int PRE_OP_MODE

See Also:

• Constant Field Values

RUNNING_MODE

public static final int RUNNING_MODE

See Also:

• Constant Field Values

Constructor Details

CMS

public CMS()

Method Details

getProductName

public static String getProductName()
                             throws Exception

Return the product name from /usr/share/pki/CS_SERVER_VERSION which is provided by the server theme package.

Throws:

Exception

getProductVersion

public static String getProductVersion()

getInstanceDir

public static String getInstanceDir()

getInstanceID

public static String getInstanceID()

getUserMessage

public static String getUserMessage(String msgID,
 String... params)

Retrieves the localized user message from UserMessages.properties.

Parameters:

msgID - message id defined in UserMessages.properties

params - an array of parameters

Returns:

localized user message

getUserMessage

public static String getUserMessage(Locale locale,
 String msgID,
 String... params)

Retrieves the localized user message from UserMessages.properties.

Parameters:

locale - end-user locale

msgID - message id defined in UserMessages.properties

params - an array of parameters

Returns:

localized user message

getLogMessage

public static String getLogMessage(String msgID,
 Object... params)

Retrieves log message from LogMessages.properties or audit-events.properties.

Parameters:

msgID - message ID defined in LogMessages.properties or audit-events.properties

params - string parameters

Returns:

localized log message

isSensitive

public static boolean isSensitive(String name)

Check whether the string is contains password

Parameters:

name - key string

Returns:

whether key is a password or not

createPasswordStore

public static PasswordStore createPasswordStore(PasswordStoreConfig psc)
                                         throws Exception

Construct a password store. If the process was started by Nuxwdog return a NuxwdogPasswordStore. Otherwise the class name is read from the "passwordClass" key in the map, an instance is constructed, its init() method is called with the value of the "passwordFile" key in the map, and the instance is returned.

Throws:

Exception