uws.job

Class SerializableUWSObject

java.lang.Object

uws.job.SerializableUWSObject

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ErrorSummary, JobList, Result, UWSJob

public abstract class SerializableUWSObject
extends java.lang.Object
implements java.io.Serializable

This class defines the methods that an object of the UWS pattern must implement to be written in any format (by default, XML ; see XMLSerializer).

The serialize(UWSSerializer, JobOwner) method must be implemented. It is the most important method of this class because it returns a serialized representation of this UWS object.

Version:

4.1 (08/2014)

Author:

Grégory Mantelet (CDS;ARI)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SerializableUWSObject()

Method Summary

Modifier and Type	Method and Description
void	serialize(javax.servlet.ServletOutputStream output, UWSSerializer serializer) Serializes the whole object in the given output stream and thanks to the given serializer.
void	serialize(javax.servlet.ServletOutputStream output, UWSSerializer serializer, JobOwner owner) Serializes the while object in the given output stream, considering the given owner ID and thanks to the given serializer.
java.lang.String	serialize(UWSSerializer serializer) Serializes the whole object thanks to the given serializer.
abstract java.lang.String	serialize(UWSSerializer serializer, JobOwner owner) Serializes the whole object considering the given owner (supposed to be the current user) and thanks to the given serializer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SerializableUWSObject

public SerializableUWSObject()

Method Detail

serialize

public java.lang.String serialize(UWSSerializer serializer)
                           throws java.lang.Exception

Serializes the whole object thanks to the given serializer.

Parameters:

serializer - The serializer to use.

Returns:

The serialized representation of this object.

Throws:

java.lang.Exception - If there is an unexpected error during the serialization.

See Also:

serialize(UWSSerializer, JobOwner)

serialize

public abstract java.lang.String serialize(UWSSerializer serializer,
                                           JobOwner owner)
                                    throws UWSException,
                                           java.lang.Exception

Serializes the whole object considering the given owner (supposed to be the current user) and thanks to the given serializer.

Parameters:

serializer - The serializer to use.

owner - The current user.

Returns:

The serialized representation of this object.

Throws:

UWSException - If the owner is not allowed to see the content of the serializable object.

java.lang.Exception - If there is any other error during the serialization.

serialize

public void serialize(javax.servlet.ServletOutputStream output,
                      UWSSerializer serializer)
               throws java.lang.Exception

Serializes the whole object in the given output stream and thanks to the given serializer.

Parameters:

output - The output stream in which this object must be serialized.

serializer - The serializer to use.

Throws:

UWSException - If there is an error during the serialization.

java.lang.Exception

See Also:

serialize(ServletOutputStream, UWSSerializer, JobOwner)

serialize

public void serialize(javax.servlet.ServletOutputStream output,
                      UWSSerializer serializer,
                      JobOwner owner)
               throws UWSException,
                      java.io.IOException,
                      java.lang.Exception

Serializes the while object in the given output stream, considering the given owner ID and thanks to the given serializer.

Parameters:

output - The ouput stream in which this object must be serialized.

serializer - The serializer to use.

owner - The user who asks for the serialization.

Throws:

UWSException - If the owner is not allowed to see the content of the serializable object.

java.io.IOException - If there is an error while writing in the given stream.

java.lang.Exception - If there is any other error during the serialization.

See Also:

serialize(UWSSerializer, JobOwner)