com.metamatrix.admin.api.objects
Interface Principal

All Superinterfaces:

AdminObject

All Known Subinterfaces:

Group, User

All Known Implementing Classes:

MMGroup, MMPrincipal, MMUser

public interface Principal
extends AdminObject

A Principal may participate in entitlements (authorization). A Principal may also posess administrative roles for the system.

The identifier pattern for all principal types is "name". A name is concidered to be unique across the system for all principal types.

Since:

4.3

Field Summary

static int	NAME_LEN_LIMIT User and Group names can be no longer then this
static int	TYPE_ADMIN Admin internal type.
static int	TYPE_GROUP Group internal type
static java.lang.String	TYPE_LABEL_ADMIN Display String for Admin type
static java.lang.String	TYPE_LABEL_GROUP Display String for Group type
static java.lang.String	TYPE_LABEL_USER Display String for User type
static int	TYPE_USER User internal type.

Fields inherited from interface com.metamatrix.admin.api.objects.AdminObject

DELIMITER, DELIMITER_CHAR, ESCAPED_DELIMITER, ESCAPED_WILDCARD, WILDCARD

Method Summary

int	getType() Get the Principal type for this principal.
java.lang.String	getTypeLabel() Get the Principal type String for this principal.

Methods inherited from interface com.metamatrix.admin.api.objects.AdminObject

getIdentifier, getName, getProperties, getPropertyValue

Field Detail

TYPE_USER

static final int TYPE_USER

User internal type. Note that a User can be of type Admin and vice versa.

See Also:

Constant Field Values

TYPE_GROUP

static final int TYPE_GROUP

Group internal type

See Also:

Constant Field Values

TYPE_ADMIN

static final int TYPE_ADMIN

Admin internal type. Note that a User can be of type Admin and vice versa.

See Also:

Constant Field Values

TYPE_LABEL_USER

static final java.lang.String TYPE_LABEL_USER

Display String for User type

See Also:

Constant Field Values

TYPE_LABEL_GROUP

static final java.lang.String TYPE_LABEL_GROUP

Display String for Group type

See Also:

Constant Field Values

TYPE_LABEL_ADMIN

static final java.lang.String TYPE_LABEL_ADMIN

Display String for Admin type

See Also:

Constant Field Values

NAME_LEN_LIMIT

static final int NAME_LEN_LIMIT

User and Group names can be no longer then this

See Also:

Constant Field Values

Method Detail

getType

int getType()

Get the Principal type for this principal.

Returns:

the internal type of this user.

Since:

4.3

getTypeLabel

java.lang.String getTypeLabel()

Get the Principal type String for this principal.

Returns:

the String representation type of this user.

Since:

4.3