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 org.opensaml.ws.message.decoder; 18 19 import org.opensaml.ws.message.MessageContext; 20 import org.opensaml.xml.security.SecurityException; 21 22 /** 23 * Decodes a message, from an inbound transport, in a binding specific mannger. As the decode proceeds information is 24 * stored in the {@link MessageContext}. The decoding process deserializes the message from the inbound transport into 25 * its DOM representation, unmarshall the DOM into the appropriate XMLObject, and then evaluates the security policy 26 * against the inbound transport and decoded message. 27 * 28 * Message decoders <strong>MUST</strong> must be thread safe and stateless. 29 */ 30 public interface MessageDecoder { 31 32 /** 33 * Decodes a message in a binding specific manner. 34 * 35 * @param messageContext current message context 36 * 37 * @throws MessageDecodingException thrown if the message can not be decoded 38 * @throws SecurityException thrown if the decoded message does not meet the required security constraints 39 */ 40 public void decode(MessageContext messageContext) throws MessageDecodingException, SecurityException; 41 42 }