SystemResource (P2J - Progress 4GL to Java Conversion and Runtime)

java.lang.Object
- com.goldencode.expr.Scope
- - com.goldencode.p2j.security.AbstractResource
  - - com.goldencode.p2j.security.SystemResource

All Implemented Interfaces:

Resource
```
class SystemResource
extends AbstractResource
```
Implements the "system" abstract resource. Instances of this resource control access to various features of the P2J application. Currently defined instances are:
- logon - allows logging on to the P2J server
- context - names security context related events for audit
- change - controls access to the batch editing feature
- shutdown - controls access to the server shutdown
- debug - controls access to the debug level change

Field Summary

Fields
Modifier and Type	Field and Description
`private static CentralLogger`	`LOG` Logger.
`(package private) static int`	`SYSTEM_ACCESS` the only access mode for "system" resources
`(package private) static int`	`SYSTEM_CONTEXT_CREATE` context related event constant
`(package private) static int`	`SYSTEM_CONTEXT_DELETE` context related event constant
`(package private) static int`	`SYSTEM_CONTEXT_SWITCH` context related event constant
`private static java.lang.String[]`	`validInstances` array of valid instance names

Fields inherited from class com.goldencode.p2j.security.AbstractResource
objectPointer, resourceIndex, sm

Constructor Summary

Constructors
Constructor and Description

SystemResource()
Package private constructor.

Constructors
Constructor and Description
`SystemResource()` Package private constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`(package private) boolean`	`checkAccountsAccess()` Checks access rights of the current subject with regards to the "accounts" instance of the "system" abstract resource.
`(package private) boolean`	`checkAdminAccess()` Checks access rights of the current subject with regards to the "admin" instance of the "system" abstract resource.
`(package private) boolean`	`checkChangeAccess()` Checks access rights of the current subject with regards to the "change" instance of the "system" abstract resource.
`(package private) boolean`	`checkDebugAccess()` Checks access rights of the current subject with regards to the "debug" instance of the "system" abstract resource.
`(package private) boolean`	`checkExtensionsAccess()` Checks access rights of the current subject with regards to the "extensions" instance of the "system" abstract resource.
`(package private) boolean`	`checkLogonAccess()` Checks access rights of the current subject with regards to the "logon" instance of the "system" abstract resource.
`(package private) boolean`	`checkShutdownAccess()` Checks access rights of the current subject with regards to the "shutdown" instance of the "system" abstract resource.
`private boolean`	`checkSingle(SystemRights rights)` Implements a worker that performs access rights check on a single instance of the SystemRights object.
`Description[]`	`describeRights()` Returns an array of descriptions, one object per the plugin's access rights item.
`Rights`	`getRightsInstance(java.lang.Object[] rights)` Instantiates a plugin's class that implements the Rights interface, using the array of objects representing a set of access rights fields.
`java.lang.String`	`getTypeName()` Returns the plugin resource type name as a string.
`boolean`	`isInstanceNameValid(java.lang.String resource)` Checks whether a given string is a valid resource name for this resource type.
`boolean`	`isRightsSetValid(java.lang.Object[] rights)` Checks whether a given array of objects representing a set of access rights fields is acceptable.
`private boolean`	`systemAccessWorker(java.lang.String instanceName, int mode)` Implements generalized access rights check worker.

Methods inherited from class com.goldencode.p2j.security.AbstractResource
associate, attach, disassociate, getACLMatcher, getEnclosingScope, getLibrary, getLink, getPermissions, init, refresh, registeredAs, toString

Methods inherited from class com.goldencode.expr.Scope
getLibraries, getLibraryClasses, getLibsByClass, getVariableList, getVariables

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - SYSTEM_ACCESS
```
static final int SYSTEM_ACCESS
```
    the only access mode for "system" resources
    
    See Also:
    
    Constant Field Values
  - SYSTEM_CONTEXT_CREATE
```
static final int SYSTEM_CONTEXT_CREATE
```
    context related event constant
    
    See Also:
    
    Constant Field Values
  - SYSTEM_CONTEXT_DELETE
```
static final int SYSTEM_CONTEXT_DELETE
```
    context related event constant
    
    See Also:
    
    Constant Field Values
  - SYSTEM_CONTEXT_SWITCH
```
static final int SYSTEM_CONTEXT_SWITCH
```
    context related event constant
    
    See Also:
    
    Constant Field Values
  - validInstances
```
private static final java.lang.String[] validInstances
```
    array of valid instance names
  - LOG
```
private static final CentralLogger LOG
```
    Logger.
- Constructor Detail
  - SystemResource
```
SystemResource()
```
    Package private constructor.
- Method Detail
  - getTypeName
```
public java.lang.String getTypeName()
```
    Returns the plugin resource type name as a string.
    
    Returns:
    
    plugin resource type name
  - describeRights
```
public Description[] describeRights()
```
    Returns an array of descriptions, one object per the plugin's access rights item.
    
    Returns:
    
    array of Descriptions, one per each plugin's access rights item.
  - getRightsInstance
```
public Rights getRightsInstance(java.lang.Object[] rights)
```
    Instantiates a plugin's class that implements the Rights interface, using the array of objects representing a set of access rights fields.
    
    Parameters:
    
    rights - an array of objects of proper types representing items in a set of access rights
    
    Returns:
    
    the reference to the interface.
  - isInstanceNameValid
```
public boolean isInstanceNameValid(java.lang.String resource)
```
    Checks whether a given string is a valid resource name for this resource type.
    
    Parameters:
    
    resource - string naming a resource
    
    Returns:
    
    true if the name is syntactically correct
  - isRightsSetValid
```
public boolean isRightsSetValid(java.lang.Object[] rights)
```
    Checks whether a given array of objects representing a set of access rights fields is acceptable.
    
    Parameters:
    
    rights - an array of objects of proper types representing items in a set of access rights
    
    Returns:
    
    true if the array is acceptable for an instance of access rights
  - checkLogonAccess
```
boolean checkLogonAccess()
```
    Checks access rights of the current subject with regards to the "logon" instance of the "system" abstract resource.
    
    Returns:
    
    true if access is allowed.
  - checkChangeAccess
```
boolean checkChangeAccess()
```
    Checks access rights of the current subject with regards to the "change" instance of the "system" abstract resource.
    
    Returns:
    
    true if access is allowed.
  - checkShutdownAccess
```
boolean checkShutdownAccess()
```
    Checks access rights of the current subject with regards to the "shutdown" instance of the "system" abstract resource.
    
    Returns:
    
    true if access is allowed.
  - checkDebugAccess
```
boolean checkDebugAccess()
```
    Checks access rights of the current subject with regards to the "debug" instance of the "system" abstract resource.
    
    Returns:
    
    true if access is allowed.
  - checkAccountsAccess
```
boolean checkAccountsAccess()
```
    Checks access rights of the current subject with regards to the "accounts" instance of the "system" abstract resource.
    
    Returns:
    
    true if access is allowed.
  - checkExtensionsAccess
```
boolean checkExtensionsAccess()
```
    Checks access rights of the current subject with regards to the "extensions" instance of the "system" abstract resource.
    
    Returns:
    
    true if access is allowed.
  - checkAdminAccess
```
boolean checkAdminAccess()
```
    Checks access rights of the current subject with regards to the "admin" instance of the "system" abstract resource.
    
    Returns:
    
    true if access is allowed.
  - systemAccessWorker
```
private boolean systemAccessWorker(java.lang.String instanceName,
                                   int mode)
```
    Implements generalized access rights check worker.
    
    Parameters:
    
    instanceName - name of the particular instance of the abstract resource about to be accessed
    
    mode - an integer value encoding the access mode specific to this resource
    
    Returns:
    
    true if access is allowed.
  - checkSingle
```
private boolean checkSingle(SystemRights rights)
```
    Implements a worker that performs access rights check on a single instance of the SystemRights object.
    
    Parameters:
    
    rights - The instance of SystemRights to check, must not be null.
    
    Returns:
    
    true if access is allowed.

Class SystemResource

Field Summary

Fields inherited from class com.goldencode.p2j.security.AbstractResource

Constructor Summary

Method Summary

Methods inherited from class com.goldencode.p2j.security.AbstractResource

Methods inherited from class com.goldencode.expr.Scope

Methods inherited from class java.lang.Object

Field Detail

SYSTEM_ACCESS

SYSTEM_CONTEXT_CREATE

SYSTEM_CONTEXT_DELETE

SYSTEM_CONTEXT_SWITCH

validInstances

LOG

Constructor Detail

SystemResource

Method Detail

getTypeName

describeRights

getRightsInstance

isInstanceNameValid

isRightsSetValid

checkLogonAccess

checkChangeAccess

checkShutdownAccess

checkDebugAccess

checkAccountsAccess

checkExtensionsAccess

checkAdminAccess

systemAccessWorker

checkSingle