X-Git-Url: http://www.project-moonshot.org/gitweb/?a=blobdiff_plain;f=saml%2Fexceptions.h;h=7048c557a3647c4b0633325e7fd9981467001d66;hb=04482c5c0e5fac5b688b0d23713526a15c51bd31;hp=4aea899218a58b1fe4fb1e0d53910ac961616426;hpb=7283a1f3e79d0f6235afa8d2e7a0d17771a3d64b;p=shibboleth%2Fcpp-opensaml.git

diff --git a/saml/exceptions.h b/saml/exceptions.h
index 4aea899..7048c55 100644
--- a/saml/exceptions.h
+++ b/saml/exceptions.h
@@ -1,21 +1,25 @@
-/*
- *  Copyright 2001-2006 Internet2
- * 
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
+/**
+ * Licensed to the University Corporation for Advanced Internet
+ * Development, Inc. (UCAID) under one or more contributor license
+ * agreements. See the NOTICE file distributed with this work for
+ * additional information regarding copyright ownership.
+ *
+ * UCAID licenses this file to you under the Apache License,
+ * Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License. You may obtain a copy of the
+ * License at
  *
- *     http://www.apache.org/licenses/LICENSE-2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
  *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the License.
  */
 
 /**
- * @file exceptions.h
+ * @file saml/exceptions.h
  * 
  * Exception classes
  */
@@ -23,10 +27,75 @@
 #ifndef __saml_exceptions_h__
 #define __saml_exceptions_h__
 
+#include <saml/base.h>
 #include <xmltooling/exceptions.h>
 
 namespace opensaml {
     
+    namespace saml2p {
+        class SAML_API Status;
+    };
+    namespace saml2md {
+        class SAML_API EntityDescriptor;
+        class SAML_API RoleDescriptor;
+    };
+    
+    DECL_XMLTOOLING_EXCEPTION(SecurityPolicyException,SAML_EXCEPTIONAPI(SAML_API),opensaml,xmltooling::XMLToolingException,Exceptions in security policy processing);
+    DECL_XMLTOOLING_EXCEPTION(BindingException,SAML_EXCEPTIONAPI(SAML_API),opensaml,xmltooling::XMLToolingException,Exceptions in SAML binding processing);
+    DECL_XMLTOOLING_EXCEPTION(ProfileException,SAML_EXCEPTIONAPI(SAML_API),opensaml,xmltooling::ValidationException,Exceptions in SAML profile processing);
+    DECL_XMLTOOLING_EXCEPTION(FatalProfileException,SAML_EXCEPTIONAPI(SAML_API),opensaml,ProfileException,Fatal exceptions in SAML profile processing);
+    DECL_XMLTOOLING_EXCEPTION(RetryableProfileException,SAML_EXCEPTIONAPI(SAML_API),opensaml,ProfileException,Non-fatal exceptions in SAML profile processing);
+
+    /**
+     * Attaches metadata-derived information as exception properties and optionally
+     * rethrows the object. The following named properties are attached, when possible:
+     * 
+     *  <dl>
+     *  <dt>entityID</dt>       <dd>The unique ID of the entity</dd>
+     *  <dt>errorURL</dt>       <dd>The error support URL of a random role</dd>
+     *  <dt>contactName</dt>    <dd>A formatted support or technical contact name</dd>
+     *  <dt>contactEmail</dt>   <dd>A contact email address</dd>
+     *  <dt>statusCode</dt>     <dd>Top-level status code from Status object</dd>
+     *  <dt>statusCode2</dt>    <dd>Second-level status code from Status object</dd>
+     *  <dt>statusMessage</dt>  <dd>StatusMessage from Status object</dd>
+     *  </dl>
+     * 
+     * @param e         pointer to exception object
+     * @param entity    pointer to entity
+     * @param status    pointer to Status from message 
+     * @param rethrow   true iff the exception should be rethrown
+     */
+    void SAML_API annotateException(
+        xmltooling::XMLToolingException* e,
+        const saml2md::EntityDescriptor* entity,
+        const saml2p::Status* status=nullptr,
+        bool rethrow=true
+        );
+    
+    /**
+     * Attaches metadata-derived information as exception properties and optionally
+     * rethrows the object. The following named properties are attached, when possible:
+     * 
+     *  <dl>
+     *  <dt>entityID</dt>       <dd>The unique ID of the entity</dd>
+     *  <dt>errorURL</dt>       <dd>The error support URL of the role</dd>
+     *  <dt>contactName</dt>    <dd>A formatted support or technical contact name</dd>
+     *  <dt>contactEmail</dt>   <dd>A contact email address</dd>
+     *  <dt>statusCode</dt>     <dd>Top-level status code from Status object</dd>
+     *  <dt>statusCode2</dt>    <dd>Second-level status code from Status object</dd>
+     *  </dl>
+     * 
+     * @param e         pointer to exception object
+     * @param entity    pointer to role
+     * @param status    pointer to Status from message 
+     * @param rethrow   true iff the exception should be rethrown
+     */
+    void SAML_API annotateException(
+        xmltooling::XMLToolingException* e,
+        const saml2md::RoleDescriptor* role,
+        const saml2p::Status* status=nullptr,
+        bool rethrow=true
+        );
 };
 
 #endif /* __saml_exceptions_h__ */