org.openliberty.openaz.pep
Class PepRequest

java.lang.Object
  extended by org.openliberty.openaz.pep.PepRequest

public class PepRequest
extends java.lang.Object

A wrapper around the AzRequestContext

Author:
Josh Bregman, Rich Levinson, Prateek Mishra

Nested Class Summary
static class PepRequest.QUERY_TYPE
           
 
Method Summary
 PepResponse decide()
          Calls the AzService for a decision and returns the information to the caller in the form of a PepResponse
 AzRequestContext getAzRequestContext()
          This method is used to allow access to the underlying AzRequestContext that was created by the PepRequestFactory.
 java.lang.String getDefaultContainerName()
           
 org.openliberty.openaz.pep.PepRequest.OPERATION getOperation()
           
 PepRequestFactory getPepRequestFactory()
           
 java.lang.String getScope()
           
 boolean isQueryReturnAllowed()
           
 void setQueryReturnAllowed(boolean queryReturnAllowed)
           
 void setScope(java.lang.String scope)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

decide

public PepResponse decide()
                   throws PepException
Calls the AzService for a decision and returns the information to the caller in the form of a PepResponse

Returns:
Throws:
PepException - if there was an error in processing the request. There is some ability by the PepResponseFactory to determine under what circumstances (i.e. XACML results and status codes) to throw an exception.
See Also:
PepResponse, PepResponseFactory

getAzRequestContext

public AzRequestContext getAzRequestContext()
This method is used to allow access to the underlying AzRequestContext that was created by the PepRequestFactory. It contains all of the state, so any changes made against it are in no way reflected in any of the objects in the pep package

Returns:
the handle to the AzRequestContext

getDefaultContainerName

public java.lang.String getDefaultContainerName()

getPepRequestFactory

public PepRequestFactory getPepRequestFactory()

setScope

public void setScope(java.lang.String scope)

getScope

public java.lang.String getScope()

setQueryReturnAllowed

public void setQueryReturnAllowed(boolean queryReturnAllowed)

isQueryReturnAllowed

public boolean isQueryReturnAllowed()

getOperation

public org.openliberty.openaz.pep.PepRequest.OPERATION getOperation()