org.apache.jetspeed.security.om
Interface InternalPrincipal

All Superinterfaces:
Cloneable, Serializable
All Known Subinterfaces:
InternalGroupPrincipal, InternalRolePrincipal, InternalUserPrincipal

public interface InternalPrincipal
extends Serializable, Cloneable

Interface representing a policy principal. This will be used by the org.apache.jetspeed.security.impl.RdbmsPolicyto retrieve specify which permissions are applied on which principal according to the JAAS policy:

 
 grant [SignedBy "signer_names"] [, CodeBase "URL"]
              [, InternalPrincipal [principal_class_name] "principal_name"]
              [, InternalPrincipal [principal_class_name] "principal_name"] ... 
        {
                   permission permission_class_name [ "target_name" ] 
                                                    [, "action"] [, SignedBy "signer_names"];
                   permission ...
        };
  
 
 

Author:
David Le Strat

Method Summary
 String getClassname()
           Getter for the principal classname.
 Timestamp getCreationDate()
           Getter for creation date.
 String getFullPath()
           Getter for the principal full path.
 Timestamp getModifiedDate()
           Getter for the modified date.
 Collection getPermissions()
           Getter for the principal permissions.
 long getPrincipalId()
           Getter for the principal id.
 boolean isEnabled()
          Getter for the enabled state
 boolean isMappingOnly()
           Getter for isMappingOnly.
 void setClassname(String classname)
           Setter for the principal classname.
 void setCreationDate(Timestamp creationDate)
           Setter for the creation date.
 void setEnabled(boolean enabled)
          Setter for the enabled state
 void setFullPath(String fullPath)
           Setter for the principal name.
 void setMappingOnly(boolean isMappingOnly)
           Setter for isMappingOnly.
 void setModifiedDate(Timestamp modifiedDate)
           Setter for the modified date.
 void setPermissions(Collection permissions)
           Setter for the principal permissions.
 void setPrincipalId(long principalId)
           Setter for the principal id.
 

Method Detail

getPrincipalId

public long getPrincipalId()

Getter for the principal id.

Returns:
The principal id.

setPrincipalId

public void setPrincipalId(long principalId)

Setter for the principal id.

Parameters:
principalId - The principal id.

getClassname

public String getClassname()

Getter for the principal classname.

Returns:
The principal classname.

setClassname

public void setClassname(String classname)

Setter for the principal classname.

Parameters:
classname - The principal classname.

isMappingOnly

public boolean isMappingOnly()

Getter for isMappingOnly.

Returns:
The isMappingOnly.

setMappingOnly

public void setMappingOnly(boolean isMappingOnly)

Setter for isMappingOnly.

Parameters:
isMappingOnly - The isMappingOnly.

getFullPath

public String getFullPath()

Getter for the principal full path.

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

Returns:
The principal full path.

setFullPath

public void setFullPath(String fullPath)

Setter for the principal name.

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

Parameters:
fullPath - The principal full path.

getPermissions

public Collection getPermissions()

Getter for the principal permissions.

Returns:
The principal permissions.

setPermissions

public void setPermissions(Collection permissions)

Setter for the principal permissions.

Parameters:
permissions - The principal permissions.

getCreationDate

public Timestamp getCreationDate()

Getter for creation date.

Returns:
The creation date.

setCreationDate

public void setCreationDate(Timestamp creationDate)

Setter for the creation date.

Parameters:
creationDate - The creation date.

getModifiedDate

public Timestamp getModifiedDate()

Getter for the modified date.

Returns:
The modified date.

setModifiedDate

public void setModifiedDate(Timestamp modifiedDate)

Setter for the modified date.

Parameters:
modifiedDate - The modified date.

isEnabled

public boolean isEnabled()

Getter for the enabled state

Returns:
true if enabled

setEnabled

public void setEnabled(boolean enabled)
Setter for the enabled state

Parameters:
enabled - The enabled state


Copyright © 1999-2005 Apache Software Foundation. All Rights Reserved.