View Javadoc

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