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.config.attribute.resolver.dataConnector;
19  
20  import edu.internet2.middleware.shibboleth.common.attribute.resolver.provider.dataConnector.ComputedIDDataConnector;
21  
22  /**
23   * Spring factory bean for {@link ComputedIDDataConnector}s.
24   */
25  public class ComputedIDDataConnectorFactoryBean extends BaseDataConnectorFactoryBean {
26  
27      /** ID of the attribute generated by the connector. */
28      private String generatedAttribute;
29  
30      /** ID of the attribute whose first value is used when generating the computed ID. */
31      private String sourceAttribute;
32  
33      /** Salt used when computing the ID. */
34      private byte[] salt;
35  
36      /** {@inheritDoc} */
37      public Class getObjectType() {
38          return ComputedIDDataConnector.class;
39      }
40  
41      /**
42       * Gets the ID of the attribute generated by the connector.
43       * 
44       * @return ID of the attribute generated by the connector
45       */
46      public String getGeneratedAttribute() {
47          return generatedAttribute;
48      }
49  
50      /**
51       * Sets the ID of the attribute generated by the connector.
52       * 
53       * @param id ID of the attribute generated by the connector
54       */
55      public void setGeneratedAttribute(String id) {
56          generatedAttribute = id;
57      }
58  
59      /**
60       * Gets the ID of the attribute whose first value is used when generating the computed ID.
61       * 
62       * @return ID of the attribute whose first value is used when generating the computed ID
63       */
64      public String getSourceAttribute() {
65          return sourceAttribute;
66      }
67  
68      /**
69       * Sets the ID of the attribute whose first value is used when generating the computed ID.
70       * 
71       * @param id ID of the attribute whose first value is used when generating the computed ID
72       */
73      public void setSourceAttribute(String id) {
74          this.sourceAttribute = id;
75      }
76  
77      /**
78       * Gets the salt used when computing the ID.
79       * 
80       * @return salt used when computing the ID
81       */
82      public byte[] getSalt() {
83          return salt;
84      }
85  
86      /**
87       * Sets the salt used when computing the ID.
88       * 
89       * @param salt salt used when computing the ID
90       */
91      public void setSalt(byte[] salt) {
92          this.salt = salt;
93      }
94  
95      /** {@inheritDoc} */
96      protected Object createInstance() throws Exception {
97          ComputedIDDataConnector connector = new ComputedIDDataConnector(getGeneratedAttribute(), getSourceAttribute(),
98                  getSalt());
99          populateDataConnector(connector);
100         return connector;
101     }
102 }