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.attribute.resolver.provider.attributeDefinition;
19  
20  import java.util.List;
21  import java.util.Locale;
22  import java.util.Map;
23  
24  import edu.internet2.middleware.shibboleth.common.attribute.BaseAttribute;
25  import edu.internet2.middleware.shibboleth.common.attribute.encoding.AttributeEncoder;
26  import edu.internet2.middleware.shibboleth.common.attribute.resolver.provider.ResolutionPlugIn;
27  import edu.internet2.middleware.shibboleth.common.attribute.resolver.provider.dataConnector.DataConnector;
28  
29  /**
30   * A plugin used to create attributes or refine attributes provided from {@link DataConnector}s.
31   * 
32   * Attribute definitions must be stateless and thread-safe as a single instance may be used to service every request.
33   */
34  public interface AttributeDefinition extends ResolutionPlugIn<BaseAttribute> {
35  
36      /**
37       * Gets the localized human readable description of attribute.
38       * 
39       * @return human readable description of attribute
40       */
41      public Map<Locale, String> getDisplayDescriptions();
42  
43      /**
44       * Gets the localized human readable name of the attribute.
45       * 
46       * @return human readable name of the attribute
47       */
48      public Map<Locale, String> getDisplayNames();
49      
50      /**
51       * Gets the map of encoders to be added to attributes produced by this definition, keyed on encoder category.
52       * 
53       * @return encoders to be added to attributes produced by this definition
54       */
55      public List<AttributeEncoder> getAttributeEncoders();
56      
57      /**
58       * Gets whether this attribute definition is only a dependency and thus its values should never be released outside
59       * the resolver.
60       * 
61       * @return whether this attribute definition is only a dependency
62       */
63      public boolean isDependencyOnly();
64  }