|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opensaml.ws.security.provider.BasicSecurityPolicy<RequestType>
RequestType
- the message request typepublic class BasicSecurityPolicy<RequestType extends javax.servlet.ServletRequest>
Basic security policy implementation which evaluates a given set of SecurityPolicyRule
in an ordered manner.
A policy evaluates succesfully if, and only if:
Constructor Summary | |
---|---|
BasicSecurityPolicy()
Constructor. |
|
BasicSecurityPolicy(boolean authenticatedIssuer)
Constructor. |
Method Summary | |
---|---|
protected SecurityPolicyContext |
createNewContext()
Get a new instance of SecurityPolicyContext to use for a given policy evaluation. |
void |
evaluate(RequestType request,
XMLObject message)
Evaluates this policy. |
java.lang.String |
getIssuer()
Convenience method for getting the issuer of the message as determined by the registered validators, from the security policy context. |
java.util.List<SecurityPolicyRule<RequestType>> |
getPolicyRules()
Gets the rules that are evaluated for this policy. |
SecurityPolicyContext |
getSecurityPolicyContext()
Get the SecurityPolicyContext instance which stores various items of state related to the evaluation of
this policy. |
java.lang.Boolean |
isIssuerAuthenticated()
Gets whether the message issuer was authenticated. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public BasicSecurityPolicy()
public BasicSecurityPolicy(boolean authenticatedIssuer)
authenticatedIssuer
- indicates whether the issuer must be authenticatedMethod Detail |
---|
public SecurityPolicyContext getSecurityPolicyContext()
SecurityPolicyContext
instance which stores various items of state related to the evaluation of
this policy.
getSecurityPolicyContext
in interface SecurityPolicy<RequestType extends javax.servlet.ServletRequest>
public java.lang.String getIssuer()
getIssuer
in interface SecurityPolicy<RequestType extends javax.servlet.ServletRequest>
public java.lang.Boolean isIssuerAuthenticated()
isIssuerAuthenticated
in interface SecurityPolicy<RequestType extends javax.servlet.ServletRequest>
Boolean.TRUE
if the issuer was authenticated, Boolean.FALSE
if the issuer failed
authentication, or null if no authentication was attemptedpublic java.util.List<SecurityPolicyRule<RequestType>> getPolicyRules()
getPolicyRules
in interface SecurityPolicy<RequestType extends javax.servlet.ServletRequest>
public void evaluate(RequestType request, XMLObject message) throws SecurityPolicyException
evaluate
in interface SecurityPolicy<RequestType extends javax.servlet.ServletRequest>
request
- the protocol requestmessage
- the incoming message
SecurityPolicyException
- thrown if the request does not meet the requirements of this policyprotected SecurityPolicyContext createNewContext()
SecurityPolicyContext
to use for a given policy evaluation.
Subclasses may choose to override this method to create a context of the appropriate subtype.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |