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.encoding;
19  
20  /**
21   * SAML 2.0 attribute encoder.
22   */
23  public interface SAML2AttributeEncoder extends XMLObjectAttributeEncoder<org.opensaml.saml2.core.Attribute> {
24  
25      /**
26       * Gets the attribute's name format.
27       * 
28       * @return attribute's name format
29       */
30      public String getNameFormat();
31  
32      /**
33       * Sets the attribute's name format.
34       * 
35       * @param format attribute's name format
36       */
37      public void setNameFormat(String format);
38  
39      /**
40       * Gets the human friendly name of the attribute.
41       * 
42       * @return human friendly name of the attribute
43       */
44      public String getFriendlyName();
45  
46      /**
47       * Sets the human friendly name of the attribute.
48       * 
49       * @param name human friendly name of the attribute
50       */
51      public void setFriendlyName(String name);
52  }