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 package org.opensaml.saml2.core; 18 19 import javax.xml.namespace.QName; 20 21 import org.joda.time.DateTime; 22 import org.opensaml.common.SAMLVersion; 23 import org.opensaml.common.SignableSAMLObject; 24 import org.opensaml.common.xml.SAMLConstants; 25 import org.opensaml.saml2.common.Extensions; 26 27 /** 28 * SAML 2.0 Core RequestAbstractType. 29 */ 30 public interface RequestAbstractType extends SignableSAMLObject { 31 32 /** Local name of the XSI type. */ 33 public static final String TYPE_LOCAL_NAME = "RequestAbstractType"; 34 35 /** QName of the XSI type. */ 36 public static final QName TYPE_NAME = new QName(SAMLConstants.SAML20P_NS, TYPE_LOCAL_NAME, 37 SAMLConstants.SAML20P_PREFIX); 38 39 /** ID attribute name. */ 40 public static final String ID_ATTRIB_NAME = "ID"; 41 42 /** Version attribute name. */ 43 public static final String VERSION_ATTRIB_NAME = "Version"; 44 45 /** IssueInstant attribute name. */ 46 public static final String ISSUE_INSTANT_ATTRIB_NAME = "IssueInstant"; 47 48 /** Destination attribute name. */ 49 public static final String DESTINATION_ATTRIB_NAME = "Destination"; 50 51 /** Consent attribute name. */ 52 public static final String CONSENT_ATTRIB_NAME = "Consent"; 53 54 /** Unspecified consent URI. */ 55 public static final String UNSPECIFIED_CONSENT = "urn:oasis:names:tc:SAML:2.0:consent:unspecified"; 56 57 /** Obtained consent URI. */ 58 public static final String OBTAINED_CONSENT = "urn:oasis:names:tc:SAML:2.0:consent:obtained"; 59 60 /** Prior consent URI. */ 61 public static final String PRIOR_CONSENT = "urn:oasis:names:tc:SAML:2.0:consent:prior"; 62 63 /** Implicit consent URI. */ 64 public static final String IMPLICIT_CONSENT = "urn:oasis:names:tc:SAML:2.0:consent:implicit"; 65 66 /** Explicit consent URI. */ 67 public static final String EXPLICIT_CONSENT = "urn:oasis:names:tc:SAML:2.0:consent:explicit"; 68 69 /** Unavailable consent URI. */ 70 public static final String UNAVAILABLE_CONSENT = "urn:oasis:names:tc:SAML:2.0:consent:unavailable"; 71 72 /** Inapplicable consent URI. */ 73 public static final String INAPPLICABLE_CONSENT = "urn:oasis:names:tc:SAML:2.0:consent:inapplicable"; 74 75 /** 76 * Gets the SAML Version of this request. 77 * 78 * @return the SAML Version of this request. 79 */ 80 public SAMLVersion getVersion(); 81 82 /** 83 * Sets the SAML Version of this request. 84 * 85 * @param newVersion the SAML Version of this request 86 */ 87 public void setVersion(SAMLVersion newVersion); 88 89 /** 90 * Gets the unique identifier of the request. 91 * 92 * @return the unique identifier of the request 93 */ 94 public String getID(); 95 96 /** 97 * Sets the unique identifier of the request. 98 * 99 * @param newID the unique identifier of the request 100 */ 101 102 public void setID(String newID); 103 104 /** 105 * Gets the date/time the request was issued. 106 * 107 * @return the date/time the request was issued 108 */ 109 110 public DateTime getIssueInstant(); 111 112 /** 113 * Sets the date/time the request was issued. 114 * 115 * @param newIssueInstant the date/time the request was issued 116 */ 117 public void setIssueInstant(DateTime newIssueInstant); 118 119 /** 120 * Gets the URI of the destination of the request. 121 * 122 * @return the URI of the destination of the request 123 */ 124 public String getDestination(); 125 126 /** 127 * Sets the URI of the destination of the request. 128 * 129 * @param newDestination the URI of the destination of the request 130 */ 131 public void setDestination(String newDestination); 132 133 /** 134 * Gets the consent obtained from the principal for sending this request. 135 * 136 * @return the consent obtained from the principal for sending this request 137 */ 138 public String getConsent(); 139 140 /** 141 * Sets the consent obtained from the principal for sending this request. 142 * 143 * @param newConsent the new consent obtained from the principal for sending this request 144 */ 145 public void setConsent(String newConsent); 146 147 /** 148 * Gets the issuer of this request. 149 * 150 * @return the issuer of this request 151 */ 152 public Issuer getIssuer(); 153 154 /** 155 * Sets the issuer of this request. 156 * 157 * @param newIssuer the issuer of this request 158 */ 159 public void setIssuer(Issuer newIssuer); 160 161 /** 162 * Gets the Extensions of this request. 163 * 164 * @return the Status of this request 165 */ 166 public Extensions getExtensions(); 167 168 /** 169 * Sets the Extensions of this request. 170 * 171 * @param newExtensions the Extensions of this request 172 */ 173 public void setExtensions(Extensions newExtensions); 174 175 }