org.apache.jetspeed.sso.impl
Class SSOPrincipalImpl

java.lang.Object
  org.apache.jetspeed.sso.impl.SSOPrincipalImpl

All Implemented Interfaces:

SSOPrincipal

public class SSOPrincipalImpl
extends java.lang.Object
implements SSOPrincipal

SSOPrincipalImpl Class used for mapping Principal information for a site. This is the short form of the InternalPrincipalImpl .

Author:

Roger Ruttimann

Field Summary

protected java.lang.String

ojbConcreteClass The special attribute telling OJB the object's concrete type.

Constructor Summary

SSOPrincipalImpl()
InternalPrincipal implementation default constructor.

SSOPrincipalImpl(java.lang.String classname, java.lang.String fullPath)
InternalPrincipal constructor given a classname and name.

Method Summary

void	addRemotePrincipal(InternalUserPrincipal principal) addRemotePrincipal() adds a principal to the list of remote principals
java.lang.String	getClassname() Getter for the principal classname.
java.sql.Timestamp	getCreationDate() Getter for creation date.
java.lang.String	getFullPath() Getter for the principal full path.
java.sql.Timestamp	getModifiedDate() Getter for the modified date.
java.util.Collection	getPermissions() Getter for the principal permissions.
long	getPrincipalId() Getter for the principal id.
java.util.Collection	getRemotePrincipals() Getter for the remotePrincipals.
int	getSiteID() Getter for the siteID.
boolean	isEnabled() Getter for the enabled state
boolean	isMappingOnly() Getter for isMappingOnly.
void	setClassname(java.lang.String classname) Setter for the principal classname.
void	setCreationDate(java.sql.Timestamp creationDate) Setter for the creation date.
void	setEnabled(boolean enabled) Setter for the enabled state
void	setFullPath(java.lang.String fullPath) Setter for the principal name.
void	setMappingOnly(boolean isMappingOnly) Setter for isMappingOnly.
void	setModifiedDate(java.sql.Timestamp modifiedDate) Setter for the modified date.
void	setPermissions(java.util.Collection permissions) Setter for the principal permissions.
void	setPrincipalId(long principalId) Setter for the principal id.
void	setRemotePrincipals(java.util.Collection remotePrincipals) Setter for the remotePrincipals
void	setSiteID(int siteID) Setter for thesiteID

Methods inherited from class java.lang.Object

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

Field Detail

ojbConcreteClass

protected java.lang.String ojbConcreteClass

The special attribute telling OJB the object's concrete type.

NOTE: this attribute MUST be called ojbConcreteClass

Constructor Detail

SSOPrincipalImpl

public SSOPrincipalImpl()

InternalPrincipal implementation default constructor.

SSOPrincipalImpl

public SSOPrincipalImpl(java.lang.String classname,
                        java.lang.String fullPath)

InternalPrincipal constructor given a classname and name.

Parameters:

classname - The classname.

fullPath - The full path.

Method Detail

addRemotePrincipal

public void addRemotePrincipal(InternalUserPrincipal principal)

addRemotePrincipal() adds a principal to the list of remote principals

Specified by:

addRemotePrincipal in interface SSOPrincipal

Parameters:

principal - Adds remote principal to the main (logged in) principal

getPrincipalId

public long getPrincipalId()

Description copied from interface: SSOPrincipal

Getter for the principal id.

Specified by:

getPrincipalId in interface SSOPrincipal

Returns:

The principal id.

See Also:

InternalPrincipal.getPrincipalId()

setPrincipalId

public void setPrincipalId(long principalId)

Description copied from interface: SSOPrincipal

Setter for the principal id.

Specified by:

setPrincipalId in interface SSOPrincipal

Parameters:

principalId - The principal id.

See Also:

org.apache.jetspeed.security.om.InternalPrincipal#setPrincipalId(int)

getClassname

public java.lang.String getClassname()

Description copied from interface: SSOPrincipal

Getter for the principal classname.

Specified by:

getClassname in interface SSOPrincipal

Returns:

The principal classname.

See Also:

InternalPrincipal.getClassname()

setClassname

public void setClassname(java.lang.String classname)

Description copied from interface: SSOPrincipal

Setter for the principal classname.

Specified by:

setClassname in interface SSOPrincipal

Parameters:

classname - The principal classname.

See Also:

InternalPrincipal.setClassname(java.lang.String)

isMappingOnly

public boolean isMappingOnly()

Description copied from interface: SSOPrincipal

Getter for isMappingOnly.

Specified by:

isMappingOnly in interface SSOPrincipal

Returns:

Returns the isMappingOnly.

setMappingOnly

public void setMappingOnly(boolean isMappingOnly)

Description copied from interface: SSOPrincipal

Setter for isMappingOnly.

Specified by:

setMappingOnly in interface SSOPrincipal

Parameters:

isMappingOnly - The isMappingOnly to set.

getFullPath

public java.lang.String getFullPath()

Description copied from interface: SSOPrincipal

Getter for the principal full path.

The full path allows to retrieve the principal preferences from the preferences services.

Specified by:

getFullPath in interface SSOPrincipal

Returns:

The principal full path.

See Also:

InternalPrincipal.getFullPath()

setFullPath

public void setFullPath(java.lang.String fullPath)

Description copied from interface: SSOPrincipal

Setter for the principal name.

The full path allows to retrieve the principal preferences from the preferences services.

Specified by:

setFullPath in interface SSOPrincipal

Parameters:

fullPath - The principal full path.

See Also:

InternalPrincipal.setFullPath(java.lang.String)

getPermissions

public java.util.Collection getPermissions()

Description copied from interface: SSOPrincipal

Getter for the principal permissions.

Specified by:

getPermissions in interface SSOPrincipal

Returns:

The principal permissions.

See Also:

InternalPrincipal.getPermissions()

setPermissions

public void setPermissions(java.util.Collection permissions)

Description copied from interface: SSOPrincipal

Setter for the principal permissions.

Specified by:

setPermissions in interface SSOPrincipal

Parameters:

permissions - The principal permissions.

See Also:

InternalPrincipal.setPermissions(java.util.Collection)

getCreationDate

public java.sql.Timestamp getCreationDate()

Description copied from interface: SSOPrincipal

Getter for creation date.

Specified by:

getCreationDate in interface SSOPrincipal

Returns:

The creation date.

See Also:

InternalPrincipal.getCreationDate()

setCreationDate

public void setCreationDate(java.sql.Timestamp creationDate)

Description copied from interface: SSOPrincipal

Setter for the creation date.

Specified by:

setCreationDate in interface SSOPrincipal

Parameters:

creationDate - The creation date.

See Also:

InternalPrincipal.setCreationDate(java.sql.Timestamp)

getModifiedDate

public java.sql.Timestamp getModifiedDate()

Description copied from interface: SSOPrincipal

Getter for the modified date.

Specified by:

getModifiedDate in interface SSOPrincipal

Returns:

The modified date.

See Also:

InternalPrincipal.getModifiedDate()

setModifiedDate

public void setModifiedDate(java.sql.Timestamp modifiedDate)

Description copied from interface: SSOPrincipal

Setter for the modified date.

Specified by:

setModifiedDate in interface SSOPrincipal

Parameters:

modifiedDate - The modified date.

See Also:

InternalPrincipal.setModifiedDate(java.sql.Timestamp)

isEnabled

public boolean isEnabled()

Description copied from interface: SSOPrincipal

Getter for the enabled state

Specified by:

isEnabled in interface SSOPrincipal

Returns:

true if enabled

See Also:

InternalPrincipal.isEnabled()

setEnabled

public void setEnabled(boolean enabled)

Description copied from interface: SSOPrincipal

Setter for the enabled state

Specified by:

setEnabled in interface SSOPrincipal

Parameters:

enabled - The enabled state

See Also:

InternalPrincipal.setEnabled(boolean)

getRemotePrincipals

public java.util.Collection getRemotePrincipals()

Description copied from interface: SSOPrincipal

Getter for the remotePrincipals.

Specified by:

getRemotePrincipals in interface SSOPrincipal

Returns:

Returns the remotePrincipals.

setRemotePrincipals

public void setRemotePrincipals(java.util.Collection remotePrincipals)

Description copied from interface: SSOPrincipal

Setter for the remotePrincipals

Specified by:

setRemotePrincipals in interface SSOPrincipal

Parameters:

remotePrincipals - The remotePrincipals to set.

getSiteID

public int getSiteID()

Description copied from interface: SSOPrincipal

Getter for the siteID.

Specified by:

getSiteID in interface SSOPrincipal

Returns:

Returns the siteID.

setSiteID

public void setSiteID(int siteID)

Description copied from interface: SSOPrincipal

Setter for thesiteID

Specified by:

setSiteID in interface SSOPrincipal

Parameters:

siteID - The siteID to set.