src/edu/internet2/middleware/shibboleth/idp/profile/saml1/MetadataException.java

   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.idp.profile.saml1;
  18
  19
  20 /**
  21  * Metadata Exception. Generally thrown by a
  22  * {@link edu.internet2.middleware.shibboleth.common.profile.AbstractProfileHandler}
  23  * if unable ot locate needed metadata.
  24  */
  25 public class MetadataException extends java.lang.Exception {
  26
  27     /**
  28      * Creates a new instance of <code>MetadataException</code> without detail message.
  29      */
  30     public MetadataException() {
  31     }
  32
  33
  34     /**
  35      * Constructs an instance of <code>MetadataException</code> with the specified detail message.
  36      * @param message The detail message.
  37      */
  38     public MetadataException(final String message) {
  39         super(message);
  40     }
  41
  42
  43     /**
  44      * Constructs an instance of <code>MetadataException</code> with the specified cause and a detail message of
  45      * <code>(cause==null ? null : cause.toString())</code> (which typically contains
  46      * the class and detail message of cause). This constructor is useful for exceptions
  47      * that are little more than wrappers for other throwables (for example, {@link PrivilegedActionException}).
  48      *
  49      * @param cause The cause (which is saved for later retrieval by the {@link Throwable#getCause()} method).
  50      * (A <code>null</code> is permitted, and indicates that the cause is nonexistent or unknown.)
  51      */
  52     public MetadataException(final Throwable cause) {
  53         super(cause);
  54     }
  55
  56     /**
  57      * Constructs a new exception with the specified detail message and cause.
  58      *
  59      * Note that the detail message associated with cause is not automatically incorporated in this exception's detail message.
  60      *
  61      * @param message The detail message (which is saved for later retrieval by the {@link Throwable#getMessage()} method).
  62      * @param cause The cause (which is saved for later retrieval by the {@link Throwable#getCause()} method).
  63      * (A <code>null</code> is permitted, and indicates that the cause is nonexistent or unknown.)
  64      */
  65     public MetadataException(final String message, final Throwable cause) {
  66         super(message, cause);
  67     }
  68
  69 }