BaseSAML2ProfileRequestContext xref

View Javadoc

    1   /*
    2    * Copyright [2007] [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.idp.profile.saml2;
    18
    19  import org.opensaml.saml2.core.NameID;
    20  import org.opensaml.saml2.core.RequestAbstractType;
    21  import org.opensaml.saml2.core.Status;
    22  import org.opensaml.saml2.core.StatusResponseType;
    23
    24  import edu.internet2.middleware.shibboleth.common.profile.provider.BaseSAMLProfileRequestContext;
    25  import edu.internet2.middleware.shibboleth.common.relyingparty.provider.saml2.AbstractSAML2ProfileConfiguration;
    26
    27  /**
    28   * Contextual object used to accumlate information as profile requests are being processed.
    29   *
    30   * @param <RequestType> type of SAML 2 request
    31   * @param <ResponseType> type of SAML 2 response
    32   * @param <ProfileConfigurationType> configuration type for this profile
    33   */
    34  public abstract class BaseSAML2ProfileRequestContext<RequestType extends RequestAbstractType, ResponseType extends StatusResponseType, ProfileConfigurationType extends AbstractSAML2ProfileConfiguration>
    35          extends BaseSAMLProfileRequestContext<RequestType, ResponseType, NameID, ProfileConfigurationType> {
    36
    37      /** The request failure status. */
    38      private Status failureStatus;
    39
    40      /**
    41       * Gets the status reflecting a request failure.
    42       *
    43       * @return status reflecting a request failure
    44       */
    45      public Status getFailureStatus() {
    46          return failureStatus;
    47      }
    48
    49      /**
    50       * Sets the status reflecting a request failure.
    51       *
    52       * @param status status reflecting a request failure
    53       */
    54      public void setFailureStatus(Status status) {
    55          failureStatus = status;
    56      }
    57  }