All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class semper.access.ControlledModule

java.lang.Object
   |
   +----semper.access.ControlledModule

public abstract class ControlledModule

extends Object

The root class of all SEMPER modules that need to be registered with the access control manager.

ControlleModule defines the interface for the access control manager to store the access control handle it constructs into the module.

A module using resources protected by other modules using the ACM must implement this interface.

It is the responsibility of module author to ensure the modules Access Control Handle is properly protected inside the module class.

Version:

$Revision: 1.2 $ $Date: 1997/12/19 14:26:18 $

Author:

Mogens Rom Andersen ([email protected])

See Also:

registerSignedModule, AccessControlHandle, ClassProfile

ControlledModule()

getAccessControlHandle()

Get the modules access control handle

The module calls this function to get its handle.

myCertifier()

Return the name of the certifier.

myDescription()

Return the description of this module.

myName()

Return the name of this module.

myRoles()

Returns an array of role names.

storeAccessControlHandle(AccessControlHandle)

Store the access control handle for later use by the module.

 public ControlledModule()

 public abstract String myName()

Return the name of this module.

The name should be short, but describe the module adequately.

Precondition:

Should be callable immediately after the class is loaded and a new instance of it is generated.

Postcondition:

Returns a non-null name.

Todo:

(nothing)

Returns:

name of this module.

 public abstract String myDescription()

Return the description of this module.

The description is a long, multi-line, string describing this module in more detail.

Precondition:

Should be callable immediately after the class is loaded and a new instance of it is generated.

Postcondition:

Returns a non-null description.

Todo:

(nothing)

Returns:

description of this module.

 public abstract String myCertifier()

Return the name of the certifier.

Return the name of the certifer who signed this module. The certifier/module-name pair uniquely identifies an module.

Precondition:

Should be callable immediately after the class is loaded and a new instance of it is generated.

Postcondition:

Returns the name of the certifier.

Todo:

Integration with Installation module.

Returns:

name of certifier.

See Also:

registerSignedModule

 public abstract FlaggedName[] myRoles()

Returns an array of role names.

The names of the roles stored in this array are deemed appropriate as active roles for this module by the certifier. Each name is accompanied by a boolean flag indicating whether the role is initially enabled (=false) or disabled (=true).

Precondition:

Should be callable immediately after the class is loaded and a new instance of it is generated.

Postcondition:

Returns an array of FlaggedName's with non-null names.

Todo:

(nothing)

Returns:

an array of flagged names, for each certified role name plus a boolean indicating whether the role is initially enabled.

See Also:

registerSignedModule, FlaggedName

 protected boolean storeAccessControlHandle(AccessControlHandle ach)

Store the access control handle for later use by the module.

The registration procedure calls this function to store the access control handle it generates for this module and which is later used to authenticate the module with the access control service

Precondition:

The method must not have been called before

Postcondition:

The access control handle passed as parameter

Todo:

Nothing

Parameters:

ach - module access control handle.

Returns:

true if this is the first call, false otherwise

 protected static AccessControlHandle getAccessControlHandle()

Get the modules access control handle

The module calls this function to get its handle.

Precondition:

The storeAccessControlHandle must have be called during registration of the module

Postcondition:

None

Todo:

Nothing

Returns:

the module access control handle

All Packages  Class Hierarchy  This Package  Previous  Next  Index