View Javadoc

1   /*
2    * Copyright [2006] [University Corporation for Advanced Internet Development, Inc.]
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    * http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.opensaml.ws.security;
18  
19  import org.opensaml.ws.message.MessageContext;
20  
21  /**
22   * An individual rule that a message context is required to meet in order to be considered valid.
23   * 
24   * Rules <strong>MUST</strong> be thread safe and stateless.
25   */
26  public interface SecurityPolicyRule {
27  
28      /**
29       * Evaluates the message context against the rule.
30       * 
31       * @param messageContext the message context being evaluated
32       * 
33       * @throws SecurityPolicyException thrown if the message context does not meet the requirements of the rule,
34       *          or if there is a non-recoverable error during evaluation
35       */
36      public void evaluate(MessageContext messageContext) throws SecurityPolicyException;
37  }