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 java.util.List;
20  
21  import org.opensaml.ws.message.MessageContext;
22  
23  /**
24   * An ordered chain of {@link Handler} instances which may be invoked on a message context.
25   */
26  public interface HandlerChain {
27      
28      /**
29       * Invoke the handler chain on the specified message context.
30       * 
31       * @param msgContext the message context on which to invoke the handler chain
32       * @throws HandlerException if there is a problem handling the message context
33       */
34      public void invoke(MessageContext msgContext) throws HandlerException;
35      
36      
37      /**
38       * Get the modifiable list of handlers in the handler chain.
39       * 
40       * @return list of handlers
41       */
42      public List<Handler> getHandlers();
43  
44  }