View Javadoc

    1   /*
    2    * Licensed to the University Corporation for Advanced Internet Development,
    3    * Inc. (UCAID) under one or more contributor license agreements.  See the
    4    * NOTICE file distributed with this work for additional information regarding
    5    * copyright ownership. The UCAID licenses this file to You under the Apache
    6    * License, Version 2.0 (the "License"); you may not use this file except in
    7    * compliance with the License.  You may obtain a copy of the License at
    8    *
    9    *    http://www.apache.org/licenses/LICENSE-2.0
    10   *
    11   * Unless required by applicable law or agreed to in writing, software
    12   * distributed under the License is distributed on an "AS IS" BASIS,
    13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    14   * See the License for the specific language governing permissions and
    15   * limitations under the License.
    16   */
    17
    18  package edu.internet2.middleware.shibboleth.idp.profile.saml2;
    19
    20  import org.opensaml.saml2.core.NameID;
    21  import org.opensaml.saml2.core.RequestAbstractType;
    22  import org.opensaml.saml2.core.Status;
    23  import org.opensaml.saml2.core.StatusResponseType;
    24
    25  import edu.internet2.middleware.shibboleth.common.profile.provider.BaseSAMLProfileRequestContext;
    26  import edu.internet2.middleware.shibboleth.common.relyingparty.provider.saml2.AbstractSAML2ProfileConfiguration;
    27
    28  /**
    29   * Contextual object used to accumlate information as profile requests are being processed.
    30   *
    31   * @param <RequestType> type of SAML 2 request
    32   * @param <ResponseType> type of SAML 2 response
    33   * @param <ProfileConfigurationType> configuration type for this profile
    34   */
    35  public abstract class BaseSAML2ProfileRequestContext<RequestType extends RequestAbstractType, ResponseType extends StatusResponseType, ProfileConfigurationType extends AbstractSAML2ProfileConfiguration>
    36          extends BaseSAMLProfileRequestContext<RequestType, ResponseType, NameID, ProfileConfigurationType> {
    37
    38      /** The request failure status. */
    39      private Status failureStatus;
    40
    41      /**
    42       * Gets the status reflecting a request failure.
    43       *
    44       * @return status reflecting a request failure
    45       */
    46      public Status getFailureStatus() {
    47          return failureStatus;
    48      }
    49
    50      /**
    51       * Sets the status reflecting a request failure.
    52       *
    53       * @param status status reflecting a request failure
    54       */
    55      public void setFailureStatus(Status status) {
    56          failureStatus = status;
    57      }
    58  }