-/*
- * Copyright 2001-2009 Internet2
+/**
+ * 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.
*
- * 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
+ * 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.
*/
/**
virtual ~MessageDecoder();
/**
+ * Returns identifier for the protocol family associated with the decoder.
+ *
+ * @return a protocol family identifier, or nullptr
+ */
+ virtual const XMLCh* getProtocolFamily() const;
+
+ /**
* Indicates whether a web browser or similar user agent delivered the message.
*
* @return true iff the message was delivered by a user agent
* @param artifact reference to a SAML 2.0 artifact
* @param ssoDescriptor reference to SSO role of artifact issuer (may be SP or IdP)
* @param policy reference to policy containing rules, MetadataProvider, TrustEngine, etc.
- * @return the corresponding SAML protocol message or NULL
+ * @return the corresponding SAML protocol message or nullptr
*/
virtual saml2p::ArtifactResponse* resolve(
const saml2p::SAML2Artifact& artifact,
/**
* Decodes a transport request into a SAML protocol message, and evaluates it
* against a supplied SecurityPolicy. If the transport request does not contain
- * the information necessary to decode the request, NULL will be returned.
+ * the information necessary to decode the request, nullptr will be returned.
* Errors during the decoding process will be raised as exceptions.
*
* <p>Artifact-based bindings require an ArtifactResolver be set to
* @param relayState will be set to RelayState/TARGET value accompanying message
* @param genericRequest reference to interface for accessing transport request to decode
* @param policy reference to policy containing rules, MetadataProvider, TrustEngine, etc.
- * @return the decoded message, or NULL if the decoder did not recognize the request content
+ * @return the decoded message, or nullptr if the decoder did not recognize the request content
*/
virtual xmltooling::XMLObject* decode(
std::string& relayState,