Open Journal Systems  3.3.0
AuthorizationPolicy Class Reference
Inheritance diagram for AuthorizationPolicy:
ContextRequiredPolicy DataObjectRequiredPolicy HandlerOperationPolicy HttpsPolicy ManagerRequiredPolicy OjsJournalMustPublishPolicy PluginLevelRequiredPolicy PluginRequiredPolicy PublicationIsSubmissionPolicy QueryAssignedToUserAccessPolicy RestrictedSiteAccessPolicy ReviewAssignmentAccessPolicy StageRolePolicy SubmissionAuthorPolicy SubmissionFileBaseAccessPolicy UserAccessibleWorkflowStagePolicy UserAccessibleWorkflowStageRequiredPolicy UserRequiredPolicy UserRolesRequiredPolicy WorkflowStageRequiredPolicy

Public Member Functions

 __construct ($message=null)
 
 addAuthorizedContextObject ($assocType, &$authorizedObject)
 
 applies ()
 
 effect ()
 
getAdvice ($adviceType)
 
getAuthorizedContext ()
 
getAuthorizedContextObject ($assocType)
 
 hasAdvice ($adviceType)
 
 hasAuthorizedContextObject ($assocType)
 
 setAdvice ($adviceType, &$adviceContent)
 
 setAuthorizedContext (&$authorizedContext)
 

Data Fields

 $_advice = array()
 
 $_authorizedContext = array()
 

Detailed Description

Class to represent an authorization policy.

We use some of the terminology specified in the draft XACML V3.0 standard, please see http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=xacml for details.

We try to stick closely enough to XACML concepts to make sure that future improvements to the authorization framework can be done in a consistent manner.

This of course doesn't mean that we are "XACML compliant" in any way.

Definition at line 31 of file AuthorizationPolicy.inc.php.

Constructor & Destructor Documentation

◆ __construct()

AuthorizationPolicy::__construct (   $message = null)

Member Function Documentation

◆ addAuthorizedContextObject()

◆ applies()

AuthorizationPolicy::applies ( )

Whether this policy applies.

Returns
boolean

Reimplemented in RestrictedSiteAccessPolicy, and HttpsPolicy.

Definition at line 149 of file AuthorizationPolicy.inc.php.

◆ effect()

◆ getAdvice()

& AuthorizationPolicy::getAdvice (   $adviceType)

Get advice for the given advice type.

Parameters
$adviceTypeinteger
Returns
mixed

Definition at line 83 of file AuthorizationPolicy.inc.php.

References hasAdvice().

◆ getAuthorizedContext()

& AuthorizationPolicy::getAuthorizedContext ( )

Get the authorized context

Returns
array

Definition at line 138 of file AuthorizationPolicy.inc.php.

References $_authorizedContext.

◆ getAuthorizedContextObject()

◆ hasAdvice()

AuthorizationPolicy::hasAdvice (   $adviceType)

Whether this policy implements the given advice type.

Parameters
$adviceTypeinteger
Returns
boolean

Definition at line 74 of file AuthorizationPolicy.inc.php.

Referenced by getAdvice().

◆ hasAuthorizedContextObject()

AuthorizationPolicy::hasAuthorizedContextObject (   $assocType)

Check whether an object already exists in the authorized context.

Parameters
$assocTypeinteger
Returns
boolean

Definition at line 107 of file AuthorizationPolicy.inc.php.

Referenced by getAuthorizedContextObject().

◆ setAdvice()

AuthorizationPolicy::setAdvice (   $adviceType,
$adviceContent 
)

Set an advice

Parameters
$adviceTypeinteger
$adviceContentmixed

Definition at line 64 of file AuthorizationPolicy.inc.php.

Referenced by PublicationRequiredPolicy\__construct(), SubmissionRequiredPolicy\__construct(), HttpsPolicy\__construct(), and __construct().

◆ setAuthorizedContext()

AuthorizationPolicy::setAuthorizedContext ( $authorizedContext)

Set the authorized context

Returns
array

Definition at line 130 of file AuthorizationPolicy.inc.php.

Field Documentation

◆ $_advice

array AuthorizationPolicy::$_advice = array()

advice to be returned to the decision point

Definition at line 36 of file AuthorizationPolicy.inc.php.

◆ $_authorizedContext

array AuthorizationPolicy::$_authorizedContext = array()

a list of authorized context objects that should be returned to the caller

Definition at line 45 of file AuthorizationPolicy.inc.php.

Referenced by getAuthorizedContext().


The documentation for this class was generated from the following file: