org.apache.jetspeed.security
Interface BasePrincipal

All Superinterfaces:

Principal, Serializable

All Known Subinterfaces:

GroupPrincipal, RolePrincipal, UserPrincipal, UserSubjectPrincipal

public interface BasePrincipal
extends Principal, Serializable

The base principal.

Author:

David Taylor, David Le Strat

Field Summary

static String	PREFS_GROUP_ROOT The Preferences group root node
static String	PREFS_ROLE_ROOT The Preferences role root node
static String	PREFS_USER_ROOT The Preferences user root node

Method Summary

String	getFullPath() Provides the principal full path prepending PREFS_{PRINCPAL}_ROOT if not prepended.
boolean	isEnabled() Getter for the enabled state
boolean	isMapping() is this principal a security principal mapping or a real principal
void	setEnabled(boolean enabled) Setter for the enabled state

Methods inherited from interface java.security.Principal

equals, getName, hashCode, toString

Field Detail

PREFS_USER_ROOT

static final String PREFS_USER_ROOT

The Preferences user root node

See Also:

Constant Field Values

PREFS_GROUP_ROOT

static final String PREFS_GROUP_ROOT

The Preferences group root node

See Also:

Constant Field Values

PREFS_ROLE_ROOT

static final String PREFS_ROLE_ROOT

The Preferences role root node

See Also:

Constant Field Values

Method Detail

getFullPath

String getFullPath()

Provides the principal full path prepending PREFS_{PRINCPAL}_ROOT if not prepended.

Returns:

The principal full path.

isEnabled

boolean isEnabled()

Getter for the enabled state

Returns:

true if enabled

setEnabled

void setEnabled(boolean enabled)

Setter for the enabled state

Parameters:

enabled - The enabled state

isMapping

boolean isMapping()

is this principal a security principal mapping or a real principal

Returns:

true if is a mapping