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  import org.opensaml.saml2.core.NameID;
20  
21  /**
22   * SAML 2.0 NameID attribute encoder.
23   */
24  public interface SAML2NameIDEncoder extends XMLObjectAttributeEncoder<NameID> {
25  
26      /**
27       * Gets the name format URI for the NameID.
28       * 
29       * @return name format URI for the NameID
30       */
31      public String getNameFormat();
32  
33      /**
34       * Sets the name format URI for the NameID.
35       * 
36       * @param format name format URI for the NameID
37       */
38      public void setNameFormat(String format);
39  
40      /**
41       * Gets the name domain qualifier for the NameID.
42       * 
43       * @return name domain qualifier for the NameID
44       */
45      public String getNameQualifier();
46  
47      /**
48       * Sets the name domain qualifier for the NameID.
49       * 
50       * @param qualifier name domain qualifier for the NameID
51       */
52      public void setNameQualifier(String qualifier);
53  }