com.metamatrix.platform.security.api
Interface MetaMatrixPrincipal

All Superinterfaces:
java.lang.Cloneable, java.security.Principal
All Known Implementing Classes:
BasicMetaMatrixPrincipal

public interface MetaMatrixPrincipal
extends java.security.Principal, java.lang.Cloneable

This interface represents an abstract notion of users, groups or applications within the MetaMatrix Security Framework. MetaMatrixPrincipal is anlogous to java.security.Principal, which it extends from.


Field Summary
static int NAME_LEN_LIMIT
           
static int TYPE_ADMIN
           
static int TYPE_GROUP
           
static java.lang.String TYPE_LABEL_ADMIN
           
static java.lang.String TYPE_LABEL_GROUP
           
static java.lang.String TYPE_LABEL_USER
           
static java.lang.String[] TYPE_NAMES
           
static int TYPE_USER
           
 
Method Summary
 java.lang.Object clone()
          Return a cloned instance of this object.
 java.util.Set getGroupNames()
          Returns the Principal for each group that this principal is a member of.
 MetaMatrixPrincipalName getMetaMatrixPrincipalName()
          Get the MetaMatrixPrincipalName for this principal.
 int getType()
          Get the type of principal
 java.lang.String getTypeLabel()
          Get the String form for the type of principal
 
Methods inherited from interface java.security.Principal
equals, getName, hashCode, toString
 

Field Detail

TYPE_USER

static final int TYPE_USER
See Also:
Constant Field Values

TYPE_GROUP

static final int TYPE_GROUP
See Also:
Constant Field Values

TYPE_ADMIN

static final int TYPE_ADMIN
See Also:
Constant Field Values

TYPE_LABEL_USER

static final java.lang.String TYPE_LABEL_USER
See Also:
Constant Field Values

TYPE_LABEL_GROUP

static final java.lang.String TYPE_LABEL_GROUP
See Also:
Constant Field Values

TYPE_LABEL_ADMIN

static final java.lang.String TYPE_LABEL_ADMIN
See Also:
Constant Field Values

NAME_LEN_LIMIT

static final int NAME_LEN_LIMIT
See Also:
Constant Field Values

TYPE_NAMES

static final java.lang.String[] TYPE_NAMES
Method Detail

getMetaMatrixPrincipalName

MetaMatrixPrincipalName getMetaMatrixPrincipalName()
Get the MetaMatrixPrincipalName for this principal.

Returns:
the MetaMatrixPrincipalName for this principal.
See Also:
MetaMatrixPrincipaName.

getType

int getType()
Get the type of principal

Returns:
the type for this principal

getTypeLabel

java.lang.String getTypeLabel()
Get the String form for the type of principal

Returns:
the type for this principal as a String

getGroupNames

java.util.Set getGroupNames()
Returns the Principal for each group that this principal is a member of.


clone

java.lang.Object clone()
Return a cloned instance of this object.

Returns:
the object that is the clone of this instance.


Copyright © 2009. All Rights Reserved.