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.handler;
18  
19  import org.opensaml.ws.message.MessageContext;
20  import org.opensaml.ws.message.decoder.MessageDecoder;
21  import org.opensaml.ws.message.encoder.MessageEncoder;
22  
23  /**
24   * A handler is invoked to implement specific business logic on a {@link MessageContext}.
25   * 
26   * <p>
27   * It is most commonly used to invoke logic within {@link MessageEncoder}'s and {@link MessageDecoder}'s,
28   * but could also be used outside of that framework.
29   * </p>
30   * 
31   */
32  public interface Handler {
33      
34      /**
35       * Invoke the handler on the specified message context.
36       * 
37       * @param msgContext the message context on which to invoke the handler
38       * @throws HandlerException if there is a problem handling the message context
39       */
40      public void invoke(MessageContext msgContext) throws HandlerException;
41  
42  }