View Javadoc

1   /*
2    * Copyright 2009 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.message;
18  
19  
20  /**
21   * An interface for components which mutate a message context, or data contained therein,
22   * based on an input value of a particular type.
23   * 
24   * @param <T> the type of input to the operation to be performed on the message context
25   */
26  public interface MessageContextMutatingFunctor<T> {
27      
28      /**
29       * Mutate the specified message context based on the supplied input value.
30       * 
31       * @param msgContext the current message context
32       * @param input the input to the mutation operation
33       * 
34       * @throws MessageException if there is a fatal error processing the context
35       */
36      public void mutate(MessageContext msgContext, T input) throws MessageException;
37  
38  }