View Javadoc

1   /*
2    * Copyright 2011 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 edu.internet2.middleware.shibboleth.idp.config.profile.authn;
18  
19  import edu.internet2.middleware.shibboleth.idp.authn.provider.ExternalAuthnSystemLoginHandler;
20  
21  /**
22   * Spring factory for {@link ExternalAuthnSystemLoginHandler}.
23   */
24  public class ExternalAuthnSystemLoginHandlerFactoryBean extends AbstractLoginHandlerFactoryBean {
25  
26      /** The context-relative path to the Filter, Servlet, or JSP that triggers the external authentication system. */
27      private String externalAuthnPath;
28  
29      /** {@inheritDoc} */
30      public Class getObjectType() {
31          return ExternalAuthnSystemLoginHandler.class;
32      }
33  
34      /**
35       * Get context-relative path to the Filter, Servlet, or JSP that triggers the external authentication system.
36       * 
37       * @return context-relative path to the Filter, Servlet, or JSP that triggers the external authentication system
38       */
39      public String getExternalAuthnPath() {
40          return externalAuthnPath;
41      }
42  
43      /**
44       * Set context-relative path to the Filter, Servlet, or JSP that triggers the external authentication system.
45       * 
46       * @param path context-relative path to the Filter, Servlet, or JSP that triggers the external authentication
47       *            system, may not be null or empty
48       */
49      public void setExternalAuthnPath(String path) {
50          externalAuthnPath = path;
51      }
52  
53      /** {@inheritDoc} */
54      protected Object createInstance() throws Exception {
55          ExternalAuthnSystemLoginHandler handler = new ExternalAuthnSystemLoginHandler();
56          handler.setExternalAuthnPath(getExternalAuthnPath());
57          populateHandler(handler);
58          return handler;
59      }
60  }