01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one
03: * or more contributor license agreements. See the NOTICE file
04: * distributed with this work for additional information
05: * regarding copyright ownership. The ASF licenses this file
06: * to you under the Apache License, Version 2.0 (the
07: * "License"); you may not use this file except in compliance
08: * with the License. You may obtain a copy of the License at
09: *
10: * http://www.apache.org/licenses/LICENSE-2.0
11: *
12: * Unless required by applicable law or agreed to in writing,
13: * software distributed under the License is distributed on an
14: * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15: * KIND, either express or implied. See the License for the
16: * specific language governing permissions and limitations
17: * under the License.
18: */
19:
20: package org.apache.axis2.context;
21:
22: import java.io.ByteArrayInputStream;
23: import java.io.ByteArrayOutputStream;
24: import java.io.IOException;
25:
26: /**
27: * An interface for use by a message handler to allow
28: * it to save and restore any message-specific data.
29: * <p/>
30: * A handler can have message-specific data that
31: * needs to be associated the message being processed.
32: * The handler can keep this message-specific data
33: * in the Messagecontext object by adding the
34: * data to the user data table via the
35: * MessageContext method. When the MessageContext
36: * object is saved (for example, to persistent storage),
37: * and restored, this interface <B>SelfManagedDataManager</B>
38: * provides a way for the handler to save and restore
39: * the handler's message-specific data.
40: *
41: * @see MessageContext
42: */
43: public interface SelfManagedDataManager {
44:
45: /**
46: * This method is invoked when the MessageContext object is being saved.
47: * <p/>
48: * Implementors are expected to iterate through the data objects they wish
49: * to save and return it in a ByteArrayOutputStream. This data will
50: * later be passed to the implementor's deserializeSelfManagedData method when
51: * the data object is to be restored.
52: * <p/>
53: * The data being saved may be the data stored by the implementor
54: * in the MessageContext object's SelfManagedData list and may include
55: * additional information such as the implementor's fields.
56: * Note that data stored by the implementor in the MessageContext object's SelfManagedData
57: * list is retrievable by calling the MessageContext.getSelfManagedData() method
58: * for EACH key/value pair.
59: *
60: * @param mc the MessageContext that is being saved
61: * @return The saved data in the output stream. Note that the
62: * format of the data in the output stream is defined
63: * by the implementor.
64: * @throws IOException
65: */
66: public ByteArrayOutputStream serializeSelfManagedData(
67: MessageContext mc) throws IOException;
68:
69: /**
70: * This method is invoked when the MessageContext object is being restored.
71: * <p/>
72: * Implementors will receive the data they had previously saved in the
73: * serializeSelfManagedData() method. Implementors are responsible for
74: * reconstituting their message-specific data.
75: *
76: * @param data ByteArrayInputStream consisting of the data that this handler had previously saved
77: * @param mc the MessageContext object being restored
78: * @throws IOException
79: */
80: public void deserializeSelfManagedData(ByteArrayInputStream data,
81: MessageContext mc) throws IOException;
82:
83: /**
84: * This method is invoked when the MessageContext object is being restored and
85: * after the deserializeSelfManagedData() method.
86: * <p/>
87: * Implementors use this method to re-establish transient message-specific data,
88: * particularly if the implementor did not save any user data in the
89: * serializeSelfManagedData() method.
90: *
91: * @param mc the MessageContext object being restored
92: */
93: public void restoreTransientData(MessageContext mc);
94:
95: }
|