com.sonicsw.mf.common.security
Interface IManagementPermission

public interface IManagementPermission

This interface defines the API of a management permission object.

See Also:

ManagementPermissionFactory, IManagementSecurityConfigurator, IConfigurePermissionBits, IManagePermissionBits, IConfigureScopeBits, IManageScopeBits

Field Summary

static java.lang.String	CONFIGURE_TYPE Constant for the "configure" management permission type.
static short	GROUP_PRINCIPAL_TYPE Constant for a group principal type.
static java.lang.String	MANAGE_TYPE Constant for the "manage" management permission type.
static java.lang.String	SUPER_USER_NAME Constant for the IManagementPermission.SUPER_USER_NAME super-user identity.
static short	UNKNOWN_PRINCIPAL_TYPE Constant for an unknown principal type.
static short	USER_PRINCIPAL_TYPE Constant for a user principal type.

Method Summary

int	getPermissions() Gets the permissions to be applied.
java.lang.String	getPrincipal() Gets the principal to which the management permission applies.
short	getPrincipalType() Gets the principal type to which the management permission applies.
int	getScope() Gets the scope to which the management permission applies.
void	setPermissions(int permissions) Sets the permissions to be applied.
void	setScope(int scope) Sets the scope to which the management permission applies.

Field Detail

CONFIGURE_TYPE

static final java.lang.String CONFIGURE_TYPE

Constant for the "configure" management permission type.

See Also:

Constant Field Values

GROUP_PRINCIPAL_TYPE

static final short GROUP_PRINCIPAL_TYPE

Constant for a group principal type.

See Also:

Constant Field Values

MANAGE_TYPE

static final java.lang.String MANAGE_TYPE

Constant for the "manage" management permission type.

See Also:

Constant Field Values

SUPER_USER_NAME

static final java.lang.String SUPER_USER_NAME

Constant for the IManagementPermission.SUPER_USER_NAME super-user identity.

See Also:

Constant Field Values

UNKNOWN_PRINCIPAL_TYPE

static final short UNKNOWN_PRINCIPAL_TYPE

Constant for an unknown principal type.

See Also:

Constant Field Values

USER_PRINCIPAL_TYPE

static final short USER_PRINCIPAL_TYPE

Constant for a user principal type.

See Also:

Constant Field Values

Method Detail

getPermissions

int getPermissions()

Gets the permissions to be applied.

See Also:

setPermissions(int), IConfigurePermissionBits, IManagePermissionBits

getPrincipal

java.lang.String getPrincipal()

Gets the principal to which the management permission applies.

Returns:

The principal name.

See Also:

getPrincipalType()

getPrincipalType

short getPrincipalType()

Gets the principal type to which the management permission applies.

Returns:

The principal type.

See Also:

getPrincipal(), USER_PRINCIPAL_TYPE, GROUP_PRINCIPAL_TYPE

getScope

int getScope()

Gets the scope to which the management permission applies.

See Also:

setScope(int), IConfigureScopeBits, IManageScopeBits

setPermissions

void setPermissions(int permissions)

Sets the permissions to be applied.

Parameters:

permissions - The sum of the permission bits to be applied.

See Also:

getPermissions(), IConfigurePermissionBits, IManagePermissionBits

setScope

void setScope(int scope)

Sets the scope to which the management permission applies.

Parameters:

scope - The sum of the scope bits to which the management permission applies.

See Also:

getScope(), IConfigureScopeBits, IManageScopeBits