org.apache.jetspeed.security.spi
Interface SecurityAccess

All Known Implementing Classes:

SecurityAccessImpl

public interface SecurityAccess

SecurityAccess

Version:

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

Author:

Scott T. Weaver

Method Summary

org.apache.jetspeed.security.om.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.
org.apache.jetspeed.security.om.InternalRolePrincipal	getInternalRolePrincipal(String roleFullPathName) Returns the InternalRolePrincipalfrom the role full path name.
Iterator	getInternalRolePrincipals(String filter) Returns a InternalRolePrincipal collection given the filter.
org.apache.jetspeed.security.om.InternalUserPrincipal	getInternalUserPrincipal(String username) Returns the InternalUserPrincipal from the user name.
org.apache.jetspeed.security.om.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(org.apache.jetspeed.security.om.InternalGroupPrincipal internalGroup) Remove the given InternalGroupPrincipal.
void	removeInternalRolePrincipal(org.apache.jetspeed.security.om.InternalRolePrincipal internalRole) Remove the given InternalRolePrincipal.
void	removeInternalUserPrincipal(org.apache.jetspeed.security.om.InternalUserPrincipal internalUser) Remove the given InternalUserPrincipal.
void	setInternalGroupPrincipal(org.apache.jetspeed.security.om.InternalGroupPrincipal internalGroup, boolean isMappingOnly) Sets the given InternalGroupPrincipal.
void	setInternalRolePrincipal(org.apache.jetspeed.security.om.InternalRolePrincipal internalRole, boolean isMappingOnly) Sets the given InternalRolePrincipal.
void	setInternalUserPrincipal(org.apache.jetspeed.security.om.InternalUserPrincipal internalUser, boolean isMappingOnly) Sets the given InternalUserPrincipal.

Method Detail

isKnownUser

public 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

public org.apache.jetspeed.security.om.InternalUserPrincipal getInternalUserPrincipal(String username)

Returns the InternalUserPrincipal from the user name.

Parameters:

username - The user name.

Returns:

The InternalUserPrincipal.

getInternalUserPrincipal

public org.apache.jetspeed.security.om.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

public Iterator getInternalUserPrincipals(String filter)

Returns a InternalUserPrincipal collection given the filter.

Parameters:

filter - The filter.

Returns:

Collection of InternalUserPrincipal.

setInternalUserPrincipal

public void setInternalUserPrincipal(org.apache.jetspeed.security.om.InternalUserPrincipal internalUser,
                                     boolean isMappingOnly)
                              throws org.apache.jetspeed.security.SecurityException

Sets the given InternalUserPrincipal.

Parameters:

internalUser - The InternalUserPrincipal.

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

Throws:

org.apache.jetspeed.security.SecurityException - Throws a SecurityException.

removeInternalUserPrincipal

public void removeInternalUserPrincipal(org.apache.jetspeed.security.om.InternalUserPrincipal internalUser)
                                 throws org.apache.jetspeed.security.SecurityException

Remove the given InternalUserPrincipal.

Parameters:

internalUser - The InternalUserPrincipal.

Throws:

org.apache.jetspeed.security.SecurityException - Throws a SecurityException.

getInternalRolePrincipal

public org.apache.jetspeed.security.om.InternalRolePrincipal getInternalRolePrincipal(String roleFullPathName)

Returns the InternalRolePrincipalfrom the role full path name.

Parameters:

roleFullPathName - The role full path name.

Returns:

The InternalRolePrincipal.

setInternalRolePrincipal

public void setInternalRolePrincipal(org.apache.jetspeed.security.om.InternalRolePrincipal internalRole,
                                     boolean isMappingOnly)
                              throws org.apache.jetspeed.security.SecurityException

Sets the given InternalRolePrincipal.

Parameters:

internalRole - The InternalRolePrincipal.

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

Throws:

org.apache.jetspeed.security.SecurityException - Throws a SecurityException.

removeInternalRolePrincipal

public void removeInternalRolePrincipal(org.apache.jetspeed.security.om.InternalRolePrincipal internalRole)
                                 throws org.apache.jetspeed.security.SecurityException

Remove the given InternalRolePrincipal.

Parameters:

internalRole - The InternalRolePrincipal.

Throws:

org.apache.jetspeed.security.SecurityException - Throws a SecurityException.

getInternalGroupPrincipal

public org.apache.jetspeed.security.om.InternalGroupPrincipal getInternalGroupPrincipal(String groupFullPathName)

Returns the InternalGroupPrincipalfrom the group full path name.

Parameters:

groupFullPathName - The group full path name.

Returns:

The InternalGroupPrincipal.

setInternalGroupPrincipal

public void setInternalGroupPrincipal(org.apache.jetspeed.security.om.InternalGroupPrincipal internalGroup,
                                      boolean isMappingOnly)
                               throws org.apache.jetspeed.security.SecurityException

Sets the given InternalGroupPrincipal.

Parameters:

internalGroup - The InternalGroupPrincipal.

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

Throws:

org.apache.jetspeed.security.SecurityException - Throws a SecurityException.

removeInternalGroupPrincipal

public void removeInternalGroupPrincipal(org.apache.jetspeed.security.om.InternalGroupPrincipal internalGroup)
                                  throws org.apache.jetspeed.security.SecurityException

Remove the given InternalGroupPrincipal.

Parameters:

internalGroup - The InternalGroupPrincipal.

Throws:

org.apache.jetspeed.security.SecurityException - Throws a SecurityException.

getInternalRolePrincipals

public Iterator getInternalRolePrincipals(String filter)

Returns a InternalRolePrincipal collection given the filter.

Parameters:

filter - The filter.

Returns:

Collection of InternalRolePrincipal.

getInternalGroupPrincipals

public Iterator getInternalGroupPrincipals(String filter)

Returns a InternalGroupPrincipal collection of Group given the filter.

Parameters:

filter - The filter.

Returns:

Collection of InternalGroupPrincipal.