JXTA

net.jxta.endpoint
Interface WireFormatMessageFactory.Instantiator

Enclosing class:
WireFormatMessageFactory

public static interface WireFormatMessageFactory.Instantiator

Interface for instantiators of wire format messages.


Method Summary
 Message fromBuffer(ByteBuffer buffer, MimeMediaType type, MimeMediaType contentEncoding)
          Create an abstract message from a serialization.
 Message fromWire(InputStream is, MimeMediaType type, MimeMediaType contentEncoding)
          Create an abstract message from a serialization.
 MimeMediaType[] getSupportedContentEncodings()
          Returns a list of the content encodings supported by this serialization.
 MimeMediaType[] getSupportedMimeTypes()
          Returns the list of mime types supported by this serialization.
 WireFormatMessage toWire(Message msg, MimeMediaType type, MimeMediaType[] preferedContentEncoding)
          Create a WireFormatMessage from an abstract message.
 

Method Detail

getSupportedMimeTypes

MimeMediaType[] getSupportedMimeTypes()
Returns the list of mime types supported by this serialization. All of mimetypes in this list should have no mime type parameters.

Returns:
Returns the list of mime types supported by this serialization.

getSupportedContentEncodings

MimeMediaType[] getSupportedContentEncodings()
Returns a list of the content encodings supported by this serialization. These content encodings apply to both the overall coding of the message and to the encoding of individual elements.

Returns:
a list of the content encodings supported by this serialization.

toWire

WireFormatMessage toWire(Message msg,
                         MimeMediaType type,
                         MimeMediaType[] preferedContentEncoding)
Create a WireFormatMessage from an abstract message. It is an error (though lazily enforced) to modify the abstract message during the lifetime of the WireFormatMessage.

Parameters:
msg - the message for which a serialization is desired.
type - the the serialization form desired. This can include mime parameters to control options.
preferedContentEncoding - An array of acceptable message encodings in descending order of preference. any or none of these encoding options may be used. May be null for unencoded messages.
Returns:
a proxy object for the abstract message which is a representation of the message in its serialized form.

fromWire

Message fromWire(InputStream is,
                 MimeMediaType type,
                 MimeMediaType contentEncoding)
                 throws IOException
Create an abstract message from a serialization.

Parameters:
is - The message stream. Message serializations must either use internal data or EOF to determine the length of the stream.
type - Declared message type of the stream including any optional configuration parameters.
contentEncoding - Content encoding (including optional parameters) which has been applied to the message. May be null for unencoded messages.
Returns:
a proxy object for the abstract message which is a representation of the message in its serialized form.
Throws:
IOException - if an io error occurs

fromBuffer

Message fromBuffer(ByteBuffer buffer,
                   MimeMediaType type,
                   MimeMediaType contentEncoding)
                   throws IOException
Create an abstract message from a serialization.

Parameters:
buffer - The byte buffer. Message serializations must either use internal data or EOF to determine the length of the stream.
type - Declared message type of the stream including any optional configuration parameters.
contentEncoding - Content encoding (including optional parameters) which has been applied to the message. May be null for unencoded messages.
Returns:
a proxy object for the abstract message which is a representation of the message in its serialized form.
Throws:
IOException - if an io error occurs

JXSE