com.netscape.certsrv.profile
Interface IProfileSubsystem

All Superinterfaces:

ISubsystem

public interface IProfileSubsystem
extends ISubsystem

This represents the profile subsystem that manages a list of profiles.

Version:

$Revision: 1211 $, $Date: 2010-08-18 10:15:37 -0700 (Wed, 18 Aug 2010) $

Field Summary

static java.lang.String

ID

Method Summary

boolean	checkOwner() Checks if owner id should be enforced during profile approval.
IProfile	createProfile(java.lang.String id, java.lang.String classid, java.lang.String className, java.lang.String configFile) Creates new profile.
void	createProfileConfig(java.lang.String id, java.lang.String classId, java.lang.String configPath) Creates a new profile configuration file.
void	deleteProfile(java.lang.String id, java.lang.String configFile) Deletes profile.
void	disableProfile(java.lang.String id) Disables a profile.
void	enableProfile(java.lang.String id, java.lang.String enableBy) Enables a profile.
IProfile	getProfile(java.lang.String id) Retrieves a profile by id.
java.lang.String	getProfileClassId(java.lang.String id) Retrieves the id of the implementation of the given profile.
java.lang.String	getProfileEnableBy(java.lang.String id) Retrieves the approver of the given profile.
java.util.Enumeration	getProfileIds() Retrieves a list of profile ids.
boolean	isProfileEnable(java.lang.String id) Checks if a profile is approved by an agent or not.

Methods inherited from interface com.netscape.certsrv.base.ISubsystem

getConfigStore, getId, init, setId, shutdown, startup

Field Detail

ID

static final java.lang.String ID

See Also:

Constant Field Values

Method Detail

getProfile

IProfile getProfile(java.lang.String id)
                    throws EProfileException

Retrieves a profile by id.

Returns:

profile

Throws:

EProfileException - failed to retrieve

isProfileEnable

boolean isProfileEnable(java.lang.String id)

Checks if a profile is approved by an agent or not.

Parameters:

id - profile id

Returns:

true if profile is approved

getProfileEnableBy

java.lang.String getProfileEnableBy(java.lang.String id)

Retrieves the approver of the given profile.

Parameters:

id - profile id

Returns:

user id of the agent who has approved the profile

createProfile

IProfile createProfile(java.lang.String id,
                       java.lang.String classid,
                       java.lang.String className,
                       java.lang.String configFile)
                       throws EProfileException

Creates new profile.

Parameters:

id - profile id

classid - implementation id

className - class Name

configFile - configuration file

Throws:

EProfileException - failed to create profile

deleteProfile

void deleteProfile(java.lang.String id,
                   java.lang.String configFile)
                   throws EProfileException

Deletes profile.

Parameters:

id - profile id

configFile - configuration file

Throws:

EProfileException - failed to delete profile

createProfileConfig

void createProfileConfig(java.lang.String id,
                         java.lang.String classId,
                         java.lang.String configPath)
                         throws EProfileException

Creates a new profile configuration file.

Parameters:

id - profile id

classId - implementation id

configPath - location to create the configuration file

Throws:

failed - to create profile

EProfileException

enableProfile

void enableProfile(java.lang.String id,
                   java.lang.String enableBy)
                   throws EProfileException

Enables a profile.

Parameters:

id - profile id

enableBy - agent's user id

Throws:

EProfileException - failed to enable profile

disableProfile

void disableProfile(java.lang.String id)
                    throws EProfileException

Disables a profile.

Parameters:

id - profile id

Throws:

EProfileException - failed to disable

getProfileClassId

java.lang.String getProfileClassId(java.lang.String id)

Retrieves the id of the implementation of the given profile.

Parameters:

id - profile id

Returns:

implementation id managed by the registry

getProfileIds

java.util.Enumeration getProfileIds()

Retrieves a list of profile ids. The return list is of type String.

Returns:

a list of profile ids

checkOwner

boolean checkOwner()

Checks if owner id should be enforced during profile approval.

Returns:

true if approval should be checked