com.threecrickets.prudence.service

Class ResourceConversationServiceBase<R extends ServerResource>

java.lang.Object

com.threecrickets.prudence.service.ConversationService

com.threecrickets.prudence.service.ResourceConversationServiceBase<R>

Direct Known Subclasses:

DelegatedResourceConversationService, ExecutionResourceConversationService, GeneratedTextResourceConversationService

public class ResourceConversationServiceBase<R extends ServerResource>
extends ConversationService

Conversation service exposed to executables.

Author:

Tal Liron

Constructor Summary

Constructors

Constructor and Description
ResourceConversationServiceBase(R resource, Representation entity, Variant preferences, CharacterSet defaultCharacterSet, List<Encoding> supportedEncodings, int fileUploadSizeThreshold, File fileUploadDirectory) Constructor.

Method Summary

Modifier and Type	Method and Description
CharacterSet	getCharacterSet() The character set.
String	getCharacterSetName()
String	getCharacterSetShortName()
Encoding	getEncoding() The encoding.
String	getEncodingName()
Representation	getEntity() The client entity.
Language	getLanguage() The language.
String	getLanguageName()
MediaType	getMediaType() The media type.
String	getMediaTypeExtension()
String	getMediaTypeName()
Variant	getNegotiated() The negotiated client preferences.
Request	getRequest() A shortcut to the request.
R	getResource() The resource.
Response	getResponse() A shortcut to the response.
void	setCharacterSet(CharacterSet characterSet)
void	setCharacterSetName(String characterSetName)
void	setCharacterSetShortName(String characterSetShortName)
void	setEncoding(Encoding encoding)
void	setEncodingName(String encodingName)
void	setLanguage(Language language)
void	setLanguageName(String languageName)
void	setMediaType(MediaType mediaType)
void	setMediaTypeExtension(String mediaTypeExtension)
void	setMediaTypeName(String mediaTypeName)
ByteArrayRepresentation	setResponseBinary(byte[] byteArray, String mediaTypeName) A shortcut to set the response entity to a ByteArrayRepresentation.
StringRepresentation	setResponseText(String text, String mediaTypeName, String languageName, String characterSetName) A shortcut to set the response entity to a StringRepresentation.

Methods inherited from class com.threecrickets.prudence.service.ConversationService

createCookie, getApplicationRoot, getBase, getClient, getCookie, getCookies, getDisposition, getDoNotTrack, getForm, getFormAll, getHost, getInternal, getLocals, getPathToBase, getQuery, getQueryAll, getReference, getRequestHeaders, getResponseHeaders, getStatus, getStatusCode, getStatusPassthrough, getWildcard, redirectPermanent, redirectSeeOther, redirectTemporary, setStatus, setStatusCode, setStatusPassthrough, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceConversationServiceBase

public ResourceConversationServiceBase(R resource,
                                       Representation entity,
                                       Variant preferences,
                                       CharacterSet defaultCharacterSet,
                                       List<Encoding> supportedEncodings,
                                       int fileUploadSizeThreshold,
                                       File fileUploadDirectory)

Constructor.

Parameters:

resource - The resource

entity - The client entity or null

preferences - The negotiated client preferences or null

defaultCharacterSet - The character set to use if unspecified by variant

supportedEncodings - The supported encodings or null

fileUploadSizeThreshold - The size in bytes beyond which uploaded files will be stored to disk

fileUploadDirectory - The directory in which to place uploaded files

Method Detail

getEncoding

public Encoding getEncoding()

The encoding.

Returns:

The encoding or null if not set

See Also:

setEncoding(Encoding)

setEncoding

public void setEncoding(Encoding encoding)

Parameters:

encoding - The encoding or null

See Also:

getEncoding()

getEncodingName

public String getEncodingName()

Returns:

The encoding name

See Also:

getEncoding()

setEncodingName

public void setEncodingName(String encodingName)

Parameters:

encodingName - The encoding name

See Also:

setEncoding(Encoding)

getCharacterSet

public CharacterSet getCharacterSet()

The character set.

Returns:

The character set

See Also:

setCharacterSet(CharacterSet)

setCharacterSet

public void setCharacterSet(CharacterSet characterSet)

Parameters:

characterSet - The character set

See Also:

getCharacterSet()

getCharacterSetName

public String getCharacterSetName()

Returns:

The character set name

See Also:

getCharacterSet()

setCharacterSetName

public void setCharacterSetName(String characterSetName)

Parameters:

characterSetName - The character set name

See Also:

setCharacterSet(CharacterSet)

getCharacterSetShortName

public String getCharacterSetShortName()

Returns:

The character set short name

See Also:

getCharacterSet()

setCharacterSetShortName

public void setCharacterSetShortName(String characterSetShortName)

Parameters:

characterSetShortName - The character set short name

See Also:

setCharacterSet(CharacterSet)

getLanguage

public Language getLanguage()

The language.

Returns:

The language or null if not set

See Also:

setLanguage(Language)

setLanguage

public void setLanguage(Language language)

Parameters:

language - The language or null

See Also:

getLanguage()

getLanguageName

public String getLanguageName()

Returns:

The language name

See Also:

getLanguage()

setLanguageName

public void setLanguageName(String languageName)

Parameters:

languageName - The language name

See Also:

setLanguage(Language)

getMediaType

public MediaType getMediaType()

The media type.

Returns:

The media type

See Also:

setMediaType(MediaType)

setMediaType

public void setMediaType(MediaType mediaType)

Parameters:

mediaType - The media type

See Also:

getMediaType()

getMediaTypeName

public String getMediaTypeName()

Returns:

The media type name

See Also:

getMediaType()

setMediaTypeName

public void setMediaTypeName(String mediaTypeName)

Parameters:

mediaTypeName - The media type name

See Also:

setMediaType(MediaType)

getMediaTypeExtension

public String getMediaTypeExtension()

Returns:

The media type extension

See Also:

getMediaType()

setMediaTypeExtension

public void setMediaTypeExtension(String mediaTypeExtension)

Parameters:

mediaTypeExtension - The media type extension

See Also:

setMediaType(MediaType)

getResource

public R getResource()

The resource.

Returns:

The resource

getNegotiated

public Variant getNegotiated()

The negotiated client preferences.

Returns:

The negotiated preferences or null if not available

getEntity

public Representation getEntity()

The client entity.

Returns:

The client entity's representation or null if not available

getRequest

public Request getRequest()

Description copied from class: ConversationService

A shortcut to the request.

Overrides:

getRequest in class ConversationService

Returns:

The request

getResponse

public Response getResponse()

Description copied from class: ConversationService

A shortcut to the response.

Overrides:

getResponse in class ConversationService

Returns:

The response

setResponseText

public StringRepresentation setResponseText(String text,
                                            String mediaTypeName,
                                            String languageName,
                                            String characterSetName)

Description copied from class: ConversationService

A shortcut to set the response entity to a StringRepresentation.

Overrides:

setResponseText in class ConversationService

Parameters:

text - The text

mediaTypeName - The media type or null to leave unchanged

languageName - The language or null to leave unchanged

characterSetName - The character set or null to leave unchanged

Returns:

The string representation

setResponseBinary

public ByteArrayRepresentation setResponseBinary(byte[] byteArray,
                                                 String mediaTypeName)

Description copied from class: ConversationService

A shortcut to set the response entity to a ByteArrayRepresentation.

Overrides:

setResponseBinary in class ConversationService

Parameters:

byteArray - The byte array

mediaTypeName - The media type or null to leave unchanged

Returns:

The byte array representation