View Javadoc

1   /*
2    * Copyright [2005] [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  /**
18   * 
19   */
20  package org.opensaml.saml2.core;
21  
22  import javax.xml.namespace.QName;
23  
24  import org.opensaml.common.xml.SAMLConstants;
25  
26  
27  /**
28   * SAML 2.0 Core NameIDMappingRequest.
29   */
30  public interface NameIDMappingRequest extends RequestAbstractType {
31      
32      /** Element local name. */
33      public static final String DEFAULT_ELEMENT_LOCAL_NAME = "NameIDMappingRequest";
34      
35      /** Default element name. */
36      public static final QName DEFAULT_ELEMENT_NAME = 
37          new QName(SAMLConstants.SAML20P_NS, DEFAULT_ELEMENT_LOCAL_NAME, SAMLConstants.SAML20P_PREFIX);
38      
39      /** Local name of the XSI type. */
40      public static final String TYPE_LOCAL_NAME = "NameIDMappingRequestType"; 
41          
42      /** QName of the XSI type. */
43      public static final QName TYPE_NAME = 
44          new QName(SAMLConstants.SAML20P_NS, TYPE_LOCAL_NAME, SAMLConstants.SAML20P_PREFIX);
45      
46      /**
47       * Gets the base identifier of the principal for this request.
48       * 
49       * @return the base identifier of the principal for this request
50       */
51      public BaseID getBaseID();
52      
53      /**
54       * Sets the base identifier of the principal for this request.
55       * 
56       * @param newBaseID the base identifier of the principal for this request
57       */
58      public void setBaseID(BaseID newBaseID);
59      
60      /**
61       * Gets the name identifier of the principal for this request.
62       * 
63       * @return the name identifier of the principal for this request
64       */
65      public NameID getNameID();
66      
67      /**
68       * Sets the name identifier of the principal for this request.
69       * 
70       * @param newNameID the name identifier of the principal for this request
71       */
72      public void setNameID(NameID newNameID);
73      
74      /**
75       * Gets the encrypted name identifier of the principal for this request.
76       * 
77       * @return the encrypted name identifier of the principal for this request
78       */
79      public EncryptedID getEncryptedID();
80      
81      /**
82       * Sets the encrypted name identifier of the principal for this request.
83       * 
84       * @param newEncryptedID the new encrypted name identifier of the principal for this request
85       */
86      public void setEncryptedID(EncryptedID newEncryptedID);
87      
88      /**
89       * Get the NameIDPolicy of the request.
90       * 
91       * @return the NameIDPolicy of the request
92       */
93      public NameIDPolicy getNameIDPolicy();
94  
95      /**
96       * Set the NameIDPolicy of the request.
97       * 
98       * @param newNameIDPolicy the new NameIDPolicy of the request
99       */
100     public void setNameIDPolicy(NameIDPolicy newNameIDPolicy);
101 
102 
103 }