issrg.gt4Plus.pip
Class EnvironmentPIP

java.lang.Object
  extended by issrg.gt4Plus.pip.EnvironmentPIP

public class EnvironmentPIP
extends java.lang.Object

Author:
Linying Su

Constructor Summary
EnvironmentPIP()
          Creates a new instance of EnvironmentPIP
 
Method Summary
 void close()
          this method is not used.
 NonRequestEntities collectAttributes(RequestEntities requestAttr)
          this method is used to collect action attributes and passes into a RequestEntities object.
 void collectRequestAttributes(RequestEntities requestEntities)
          this method is used to collect action attributes and passes into a RequestEntities object.
 void initialize(java.lang.String chainName, java.lang.String prefix, ChainConfig config)
          this method is used to initialise the Environment PIP.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EnvironmentPIP

public EnvironmentPIP()
Creates a new instance of EnvironmentPIP

Method Detail

collectRequestAttributes

public void collectRequestAttributes(RequestEntities requestEntities)
                              throws AttributeException
this method is used to collect action attributes and passes into a RequestEntities object. this can be called if the PIP as a bootstrap PIP. this object is passed into any PDP so that the PDP can pick up the environment attributes

Parameters:
requestEntities - is the RequestEntities object.
Throws:
AttributeException

collectAttributes

public NonRequestEntities collectAttributes(RequestEntities requestAttr)
                                     throws AttributeException
this method is used to collect action attributes and passes into a RequestEntities object. this object is passed into any PDP so that the PDP can pick up the environment attributes

Parameters:
requestEntities - is the RequestEntities object.
Throws:
AttributeException

initialize

public void initialize(java.lang.String chainName,
                       java.lang.String prefix,
                       ChainConfig config)
                throws InitializeException
this method is used to initialise the Environment PIP.

Parameters:
chainName - denotes the service name, which is protected by the PIP.
prefix - denotes the scope of the Environment PIP.
config - passes the properties which are configured in the security descriptor
Throws:
InitializeException

close

public void close()
           throws CloseException
this method is not used.

Throws:
CloseException