View Javadoc

1   /*
2    * Licensed to the University Corporation for Advanced Internet Development, 
3    * Inc. (UCAID) under one or more contributor license agreements.  See the 
4    * NOTICE file distributed with this work for additional information regarding
5    * copyright ownership. The UCAID licenses this file to You under the Apache 
6    * License, Version 2.0 (the "License"); you may not use this file except in 
7    * compliance with the License.  You may obtain a copy of the License at
8    *
9    *    http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package edu.internet2.middleware.shibboleth.common.profile.provider;
19  
20  import java.util.ArrayList;
21  import java.util.List;
22  
23  import org.opensaml.ws.transport.InTransport;
24  import org.opensaml.ws.transport.OutTransport;
25  
26  import edu.internet2.middleware.shibboleth.common.profile.ProfileHandler;
27  
28  /**
29   * A request handler that is associated with a list of request URI, as defined by the HTTP servlet request.
30   * 
31   * @param <InTransportType> inbound transport type
32   * @param <OutTransportType> outbount transport type
33   */
34  public abstract class AbstractRequestURIMappedProfileHandler<InTransportType extends InTransport, OutTransportType extends OutTransport>
35          implements ProfileHandler<InTransportType, OutTransportType> {
36  
37      /** Request paths that to which this profile handler will respond. */
38      private List<String> requestPaths;
39  
40      /** Constructor. */
41      protected AbstractRequestURIMappedProfileHandler() {
42          requestPaths = new ArrayList<String>();
43      }
44  
45      /**
46       * Gets the request paths that to which this profile handler will respond.
47       * 
48       * @return request paths that to which this profile handler will respond
49       */
50      public List<String> getRequestPaths() {
51          return requestPaths;
52      }
53  
54      /**
55       * Sets the request paths that to which this profile handler will respond.
56       * 
57       * @param paths request paths that to which this profile handler will respond
58       */
59      public void setRequestPaths(List<String> paths) {
60          requestPaths = paths;
61      }
62  }