2 * Copyright 2001-2007 Internet2
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 * @file saml/exceptions.h
23 #ifndef __saml_exceptions_h__
24 #define __saml_exceptions_h__
26 #include <saml/base.h>
27 #include <xmltooling/exceptions.h>
32 class SAML_API Status;
35 class SAML_API EntityDescriptor;
36 class SAML_API RoleDescriptor;
39 DECL_XMLTOOLING_EXCEPTION(SecurityPolicyException,SAML_EXCEPTIONAPI(SAML_API),opensaml,xmltooling::XMLToolingException,Exceptions in security policy processing);
40 DECL_XMLTOOLING_EXCEPTION(BindingException,SAML_EXCEPTIONAPI(SAML_API),opensaml,xmltooling::XMLToolingException,Exceptions in SAML binding processing);
41 DECL_XMLTOOLING_EXCEPTION(ProfileException,SAML_EXCEPTIONAPI(SAML_API),opensaml,xmltooling::ValidationException,Exceptions in SAML profile processing);
42 DECL_XMLTOOLING_EXCEPTION(FatalProfileException,SAML_EXCEPTIONAPI(SAML_API),opensaml,ProfileException,Fatal exceptions in SAML profile processing);
43 DECL_XMLTOOLING_EXCEPTION(RetryableProfileException,SAML_EXCEPTIONAPI(SAML_API),opensaml,ProfileException,Non-fatal exceptions in SAML profile processing);
46 * Attaches metadata-derived information as exception properties and optionally
47 * rethrows the object. The following named properties are attached, when possible:
50 * <dt>entityID</dt> <dd>The unique ID of the entity</dd>
51 * <dt>errorURL</dt> <dd>The error support URL of a random role</dd>
52 * <dt>contactName</dt> <dd>A formatted support or technical contact name</dd>
53 * <dt>contactEmail</dt> <dd>A contact email address</dd>
54 * <dt>statusCode</dt> <dd>Top-level status code from Status object</dd>
55 * <dt>statusCode2</dt> <dd>Second-level status code from Status object</dd>
56 * <dt>statusMessage</dt> <dd>StatusMessage from Status object</dd>
59 * @param e pointer to exception object
60 * @param entity pointer to entity
61 * @param status pointer to Status from message
62 * @param rethrow true iff the exception should be rethrown
64 void SAML_API annotateException(
65 xmltooling::XMLToolingException* e,
66 const saml2md::EntityDescriptor* entity,
67 const saml2p::Status* status=NULL,
72 * Attaches metadata-derived information as exception properties and optionally
73 * rethrows the object. The following named properties are attached, when possible:
76 * <dt>entityID</dt> <dd>The unique ID of the entity</dd>
77 * <dt>errorURL</dt> <dd>The error support URL of the role</dd>
78 * <dt>contactName</dt> <dd>A formatted support or technical contact name</dd>
79 * <dt>contactEmail</dt> <dd>A contact email address</dd>
80 * <dt>statusCode</dt> <dd>Top-level status code from Status object</dd>
81 * <dt>statusCode2</dt> <dd>Second-level status code from Status object</dd>
84 * @param e pointer to exception object
85 * @param entity pointer to role
86 * @param status pointer to Status from message
87 * @param rethrow true iff the exception should be rethrown
89 void SAML_API annotateException(
90 xmltooling::XMLToolingException* e,
91 const saml2md::RoleDescriptor* role,
92 const saml2p::Status* status=NULL,
97 #endif /* __saml_exceptions_h__ */