org.nhindirect.policy

Interface PolicyFilter

All Known Implementing Classes:

DefaultPolicyFilter

public interface PolicyFilter

Policy filters are the core constructs of the policy engine as they determine if an X509 certificate is compliant with a given policy. Internally they encapsulate the functional components of the engine (parser, compiler, and execution engine), and orchestrate the flow of a certificate and policy through the engine's components.

Filters are aggregate objects. Each functional component of the policy engine can be used independently to perform specific tasks, but filters combine the components together to achieve the primary values proposition of the engine: evaluating X509 certificate compliance to a policy.

Filter instances should be created using the PolicyFilterFactory class.

Since:

1.0

Author:

Greg Meyer

Method Summary

Modifier and Type	Method and Description
boolean	isCompliant(X509Certificate cert, InputStream policyStream, PolicyLexicon lexicon) Checks if an X509 certificate is compliant with a given policy.
boolean	isCompliant(X509Certificate cert, PolicyExpression expression) Checks if an X509 certificate is compliant with a given policy.

Method Detail

isCompliant

boolean isCompliant(X509Certificate cert,
                    InputStream policyStream,
                    PolicyLexicon lexicon)
             throws PolicyProcessException

Checks if an X509 certificate is compliant with a given policy. The policy is expressed in a given lexicon which must be parsed.

Parameters:

cert - The certificate that will be checked for compliance.

policyStream - The policy stream in an input stream.

lexicon - The lexicon of the policy contained within the input stream.

Returns:

True if the certificate is compliant with the given policy. False otherwise.

Throws:

PolicyProcessException - Thrown if the policy engine process cannot be successfully executed.

isCompliant

boolean isCompliant(X509Certificate cert,
                    PolicyExpression expression)
             throws PolicyProcessException

Checks if an X509 certificate is compliant with a given policy. This is a slight variation from the other version of this method in that it takes a previously parsed PolicyExpression. This method version exists for performance reasons when it is not necessary to parse the policy expression from a lexicon input stream; it allows the reuse of a parsed PolicyExpression.

Parameters:

cert - The certificate that will be checked for compliance.

expression - A previously parsed or programmatically generated PolicyExpression.

Returns:

True if the certificate is compliant with the given policy. False otherwise.

Throws:

PolicyProcessException - Thrown if the policy engine process cannot be successfully executed.