KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > servicemix > jbi > messaging > PojoMarshaler


1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one or more
3  * contributor license agreements. See the NOTICE file distributed with
4  * this work for additional information regarding copyright ownership.
5  * The ASF licenses this file to You under the Apache License, Version 2.0
6  * (the "License"); you may not use this file except in compliance with
7  * the License. You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 package org.apache.servicemix.jbi.messaging;
18
19 import javax.jbi.messaging.InOptionalOut;
20 import javax.jbi.messaging.InOut;
21 import javax.jbi.messaging.MessageExchange;
22 import javax.jbi.messaging.MessagingException;
23 import javax.jbi.messaging.NormalizedMessage;
24
25 /**
26  * A plugin strategy which marshals an Object into and out of a JBI message.
27  * This interface is used by the ServiceMixClient to marshal POJOs into and out of JBI messages.
28  *
29  * @version $Revision: 426415 $
30  */
31 public interface PojoMarshaler {
32
33     /**
34      * The key on the message to store the message body which cannot be marshaled into or out of XML easily
35      * or to provide a cache of the object representation of the object.
36      */
37     String JavaDoc BODY = "org.apache.servicemix.body";
38
39     /**
40      * Marshals the payload into the normalized message, typically as the content
41      * property.
42      *
43      * @param exchange the message exchange in which to marshal
44      * @param message the message in which to marshal
45      * @param body the body of the message as a POJO
46      */
47     void marshal(MessageExchange exchange, NormalizedMessage message, Object JavaDoc body) throws MessagingException;
48
49     /**
50      * Unmarshals the response out of the normalized message.
51      *
52      * @param exchange the message exchange, which is an {@link InOut} or {@link InOptionalOut}
53      * @param message the output message
54      * @return the unmarshaled body object, extracted from the message
55      * @throws MessagingException
56      */
57     Object JavaDoc unmarshal(MessageExchange exchange, NormalizedMessage message) throws MessagingException;
58 }
59
Popular Tags