/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2012 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package org.glassfish.contextpropagation.weblogic.workarea;
import java.io.IOException;
/**
* <code>WorkContext</code> is a marker interface used for marshaling
* and unmarshaling user data in a <code>WorkArea</code>. The
* interfaces {@link WorkContextOutput} and
* {@link WorkContextInput} will only allow primtive types and
* objects implementing <code>WorkContext</code> to be marshaled. This
* limits the type surface area that needs to be dealt with by
* underlying protocols. <code>WorkContext</code> is analogous to
* {@link java.io.Externalizable} but with some restrictions on the types
* that can be marshaled. Advanced {@link java.io.Externalizable}
* features, such as enveloping, are not supported - implementations
* should provide their own versioning scheme if
* necessary. <code>WorkContext</code> implementations must provide a
* public no-arg constructor.
*
* @author Copyright (c) 2003 by BEA Systems Inc. All Rights Reserved.
*/
public interface WorkContext {
/**
* Writes the implementation of <code>WorkContext</code> to the
* {@link WorkContextOutput} data stream.
*/
public void writeContext(WorkContextOutput out) throws IOException;
/**
* Reads the implementation of <code>WorkContext</code> from the
* {@link WorkContextInput} data stream.
*/
public void readContext(WorkContextInput in) throws IOException;
}