org.apache.jetspeed.security.spi
Interface SecurityAccess

public interface SecurityAccess

SecurityAccess

Version:

$Id: SecurityAccess.java 290457 2005-09-20 14:14:31Z ate $

Author:

Scott T. Weaver

Method Summary

InternalGroupPrincipal	getInternalGroupPrincipal(String groupFullPathName) Returns the InternalGroupPrincipalfrom the group full path name.
Iterator	getInternalGroupPrincipals(String filter) Returns a InternalGroupPrincipal collection of Group given the filter.
InternalRolePrincipal	getInternalRolePrincipal(String roleFullPathName) Returns the InternalRolePrincipalfrom the role full path name.
Iterator	getInternalRolePrincipals(String filter) Returns a InternalRolePrincipal collection given the filter.
InternalUserPrincipal	getInternalUserPrincipal(String username) Returns the InternalUserPrincipal from the user name.
InternalUserPrincipal	getInternalUserPrincipal(String username, boolean isMappingOnly) Returns the InternalUserPrincipal from the user name.
Iterator	getInternalUserPrincipals(String filter) Returns a InternalUserPrincipal collection given the filter.
boolean	isKnownUser(String username) Returns if a Internal UserPrincipal is defined for the user name.
void	removeInternalGroupPrincipal(InternalGroupPrincipal internalGroup) Remove the given InternalGroupPrincipal.
void	removeInternalRolePrincipal(InternalRolePrincipal internalRole) Remove the given InternalRolePrincipal.
void	removeInternalUserPrincipal(InternalUserPrincipal internalUser) Remove the given InternalUserPrincipal.
void	setInternalGroupPrincipal(InternalGroupPrincipal internalGroup, boolean isMappingOnly) Sets the given InternalGroupPrincipal.
void	setInternalRolePrincipal(InternalRolePrincipal internalRole, boolean isMappingOnly) Sets the given InternalRolePrincipal.
void	setInternalUserPrincipal(InternalUserPrincipal internalUser, boolean isMappingOnly) Sets the given InternalUserPrincipal.

Method Detail

isKnownUser

boolean isKnownUser(String username)

Returns if a Internal UserPrincipal is defined for the user name.

Parameters:

username - The user name.

Returns:

true if the user is known

getInternalUserPrincipal

InternalUserPrincipal getInternalUserPrincipal(String username)

Returns the InternalUserPrincipal from the user name.

Parameters:

username - The user name.

Returns:

The InternalUserPrincipal.

getInternalUserPrincipal

InternalUserPrincipal getInternalUserPrincipal(String username,
                                               boolean isMappingOnly)

Returns the InternalUserPrincipal from the user name.

Parameters:

username - The user name.

isMappingOnly - Whether a principal's purpose is for security mappping only.

Returns:

The InternalUserPrincipal.

getInternalUserPrincipals

Iterator getInternalUserPrincipals(String filter)

Returns a InternalUserPrincipal collection given the filter.

Parameters:

filter - The filter.

Returns:

Collection of InternalUserPrincipal.

setInternalUserPrincipal

void setInternalUserPrincipal(InternalUserPrincipal internalUser,
                              boolean isMappingOnly)
                              throws SecurityException

Sets the given InternalUserPrincipal.

Parameters:

internalUser - The InternalUserPrincipal.

isMappingOnly - Whether a principal's purpose is for security mappping only.

Throws:

SecurityException - Throws a SecurityException.

removeInternalUserPrincipal

void removeInternalUserPrincipal(InternalUserPrincipal internalUser)
                                 throws SecurityException

Remove the given InternalUserPrincipal.

Parameters:

internalUser - The InternalUserPrincipal.

Throws:

SecurityException - Throws a SecurityException.

getInternalRolePrincipal

InternalRolePrincipal getInternalRolePrincipal(String roleFullPathName)

Returns the InternalRolePrincipalfrom the role full path name.

Parameters:

roleFullPathName - The role full path name.

Returns:

The InternalRolePrincipal.

setInternalRolePrincipal

void setInternalRolePrincipal(InternalRolePrincipal internalRole,
                              boolean isMappingOnly)
                              throws SecurityException

Sets the given InternalRolePrincipal.

Parameters:

internalRole - The InternalRolePrincipal.

isMappingOnly - Whether a principal's purpose is for security mappping only.

Throws:

SecurityException - Throws a SecurityException.

removeInternalRolePrincipal

void removeInternalRolePrincipal(InternalRolePrincipal internalRole)
                                 throws SecurityException

Remove the given InternalRolePrincipal.

Parameters:

internalRole - The InternalRolePrincipal.

Throws:

SecurityException - Throws a SecurityException.

getInternalGroupPrincipal

InternalGroupPrincipal getInternalGroupPrincipal(String groupFullPathName)

Returns the InternalGroupPrincipalfrom the group full path name.

Parameters:

groupFullPathName - The group full path name.

Returns:

The InternalGroupPrincipal.

setInternalGroupPrincipal

void setInternalGroupPrincipal(InternalGroupPrincipal internalGroup,
                               boolean isMappingOnly)
                               throws SecurityException

Sets the given InternalGroupPrincipal.

Parameters:

internalGroup - The InternalGroupPrincipal.

isMappingOnly - Whether a principal's purpose is for security mappping only.

Throws:

SecurityException - Throws a SecurityException.

removeInternalGroupPrincipal

void removeInternalGroupPrincipal(InternalGroupPrincipal internalGroup)
                                  throws SecurityException

Remove the given InternalGroupPrincipal.

Parameters:

internalGroup - The InternalGroupPrincipal.

Throws:

SecurityException - Throws a SecurityException.

getInternalRolePrincipals

Iterator getInternalRolePrincipals(String filter)

Returns a InternalRolePrincipal collection given the filter.

Parameters:

filter - The filter.

Returns:

Collection of InternalRolePrincipal.

getInternalGroupPrincipals

Iterator getInternalGroupPrincipals(String filter)

Returns a InternalGroupPrincipal collection of Group given the filter.

Parameters:

filter - The filter.

Returns:

Collection of InternalGroupPrincipal.