de.hybris.platform.print.comet.soap

Class DefaultCometService

java.lang.Object

de.hybris.platform.print.comet.soap.DefaultCometService

All Implemented Interfaces:

CometService

public class DefaultCometService
extends Object
implements CometService

Comet Port Implementation that controls and dispatches incoming Comet requests.

Field Summary

Fields inherited from interface de.hybris.platform.print.comet.soap.CometService

COMET_NS

Constructor Summary

Constructors

Constructor and Description
DefaultCometService()

Method Summary

Modifier and Type	Method and Description
AutocometGetNextHotfolderResult	autocometGetNextHotfolder(String sessionId, String program, String client, int status, int id) Returns the next hotfolder that AutoComet shall observe for AutoCometJobs
AutocometGetNextJobResult	autocometGetNextJob(String sessionId, String program, String client, int status) Returns the next AutoCometJob
AutocometSetDoneResult	autocometSetDone(String sessionId, int id, int status, Date starttime, Date endtime, int exitValue) Reports the end of the execution of an AutoCometJob
AutocometSetStartResult	autocometSetStart(String sessionId, int id, Date starttime, int status, String client) Reports the execution start of an AutoCometJob
AutocometSetStatusResult	autocometSetStatus(String sessionId, int id, int status) Sets the current status of an AutoCometJob
CallResult	call(String sessionId, String method, String args) Returns any kind of information, depending on the "arg" argument.
GetBinaryFileResult	getBinaryFile(String sessionId, String fileId) Returns a media that contains the requested file
protected CometResultMessageTools	getCometResultMessageTools()
GetElementListResult	getElementList(String sessionId, String method, String args) Returns an Array of CometElements that represent the content of an element list (recurring elements)
GetListResult	getList(String sessionId, String method, String args) Returns a GetListResult (contains a 2-dimensional String array) that can be used for different purposes.
Message	getMessage(String sessionId, int messageCode) Returns a (localized) (error)message for the given error code
GetProductListResult	getProductList(String sessionId, CometCondition[] conditions, CometCondition[] parentConditions)
protected PublicationController	getPublicationController() Returns the IPublicationController that is specified in the CometConfiguration of the active Publication
LoginResult	login(String login, String passwd, String client, String language) Logs in a Werk II Comet session
LogoutResult	logout(String sessionId) Logs out a Werk II Comet session
PutBinaryFileResult	putBinaryFile(String sessionId, String fileId, CometBinary file) Stores the content of the given file
SetLanguageResult	setLanguage(String sessionId, String language) Sets the language for the current Werk II Comet session

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultCometService

public DefaultCometService()

Method Detail

login

public LoginResult login(String login,
                         String passwd,
                         String client,
                         String language)

Logs in a Werk II Comet session

Specified by:

login in interface CometService

Parameters:

login - The user name for which to do the login

passwd - The user's password

client - The client that should be used in the new session

language - The language that should be used in the new session

Returns:

A LoginResult

logout

public LogoutResult logout(String sessionId)

Logs out a Werk II Comet session

Specified by:

logout in interface CometService

Parameters:

sessionId - The session ID that shall be closed

Returns:

A LogoutResult

setLanguage

public SetLanguageResult setLanguage(String sessionId,
                                     String language)

Sets the language for the current Werk II Comet session

Specified by:

setLanguage in interface CometService

Parameters:

sessionId - The session ID for which to change the language

language - The ISO code of the language to use

Returns:

A SetLanguageResult

call

public CallResult call(String sessionId,
                       String method,
                       String args)

Returns any kind of information, depending on the "arg" argument. Normally this would be a XML like text that acts as a getter for Data, e.g. if the data of a product shall be returned to display it within a placeholder

Specified by:

call in interface CometService

getMessage

public Message getMessage(String sessionId,
                          int messageCode)

Returns a (localized) (error)message for the given error code

Specified by:

getMessage in interface CometService

Parameters:

sessionId - The session ID in which's context to get the (localized) message

messageCode - The code for which to get the respective message

Returns:

The (localized) message for the given error code

getProductList

public GetProductListResult getProductList(String sessionId,
                                           CometCondition[] conditions,
                                           CometCondition[] parentConditions)

Specified by:

getProductList in interface CometService

getBinaryFile

public GetBinaryFileResult getBinaryFile(String sessionId,
                                         String fileId)

Returns a media that contains the requested file

Specified by:

getBinaryFile in interface CometService

Parameters:

sessionId - The session ID for which to get the specified file

fileId - The file name for which to get the content

Returns:

The content of the requested file

putBinaryFile

public PutBinaryFileResult putBinaryFile(String sessionId,
                                         String fileId,
                                         CometBinary file)

Stores the content of the given file

Specified by:

putBinaryFile in interface CometService

Parameters:

sessionId - The session ID to use while storing the file content

fileId - The filename of related content

file - The content that shall be stored

Returns:

A PutBinaryFileResult containing a result code

getElementList

public GetElementListResult getElementList(String sessionId,
                                           String method,
                                           String args)

Returns an Array of CometElements that represent the content of an element list (recurring elements)

Specified by:

getElementList in interface CometService

Parameters:

sessionId - The session ID in which's context to get the element list

method - The method name or type for which to get the list of elements

args - The search/request parameters

Returns:

An Array of CometElements

getList

public GetListResult getList(String sessionId,
                             String method,
                             String args)

Returns a GetListResult (contains a 2-dimensional String array) that can be used for different purposes.

Specified by:

getList in interface CometService

Parameters:

sessionId - The session ID in which's context to get the list

method - The method name or type for which to get a list

args - The search/request parameters

Returns:

A GetListResult (contains a 2-dimensional String array) that can be used for different purposes

autocometGetNextJob

public AutocometGetNextJobResult autocometGetNextJob(String sessionId,
                                                     String program,
                                                     String client,
                                                     int status)

Returns the next AutoCometJob

Specified by:

autocometGetNextJob in interface CometService

Parameters:

sessionId - The session ID in which's context to get the next AutoCometJob

program - Unused (TODO: what is this?)

client - Unused (The client in which's context the next AutoCometJob shall be searched)

status - Unused (TODO: what is this?)

Returns:

A AutocometGetNextJobResult containing the next AutoCometJob and a result code

autocometSetStart

public AutocometSetStartResult autocometSetStart(String sessionId,
                                                 int id,
                                                 Date starttime,
                                                 int status,
                                                 String client)

Reports the execution start of an AutoCometJob

Specified by:

autocometSetStart in interface CometService

Parameters:

sessionId - The session ID in which's context to start the AutoCometJob

id - The ID of the AutoCometJob that's execution has started

starttime - The time, when the execution has started

status - The AutoCometJob's current status

client - Unused (The client in which's context the AutoCometJob's execution has started)

Returns:

A AutocometSetStartResult containing a result code

autocometSetStatus

public AutocometSetStatusResult autocometSetStatus(String sessionId,
                                                   int id,
                                                   int status)

Sets the current status of an AutoCometJob

Specified by:

autocometSetStatus in interface CometService

Parameters:

sessionId - The session ID in which's context to set the status to an AutoCometJob

id - The ID of the AutoCometJob that's status becomes reported

status - The AutoCometJob's current status

Returns:

A AutocometSetStatusResult containing a result code

autocometSetDone

public AutocometSetDoneResult autocometSetDone(String sessionId,
                                               int id,
                                               int status,
                                               Date starttime,
                                               Date endtime,
                                               int exitValue)

Reports the end of the execution of an AutoCometJob

Specified by:

autocometSetDone in interface CometService

Parameters:

sessionId - The session ID in which's context to set the status of an AutoCometJob to done

id - The ID of the AutoCometJob that's execution has ended

status - The AutoCometJob's current status

starttime - The time, when the execution has started

endtime - The time, when the execution has ended

exitValue - The result code

Returns:

A AutocometSetDoneResult containing a result code

autocometGetNextHotfolder

public AutocometGetNextHotfolderResult autocometGetNextHotfolder(String sessionId,
                                                                 String program,
                                                                 String client,
                                                                 int status,
                                                                 int id)

Returns the next hotfolder that AutoComet shall observe for AutoCometJobs

Specified by:

autocometGetNextHotfolder in interface CometService

Parameters:

sessionId - The session ID in which's context to get next HotFolders

program - Unused (TODO: what is this?)

client - Unused (The client in which's context the next hotfolder shall be searched)

status - Unused (TODO: what is this?)

id - Unused (TODO: what is this?)

Returns:

A AutocometGetNextHotfolderResult containing the next HotFolder and a result code

getPublicationController

protected PublicationController getPublicationController()

Returns the IPublicationController that is specified in the CometConfiguration of the active Publication

Returns:

The IPublicationController of the active Publication

getCometResultMessageTools

protected CometResultMessageTools getCometResultMessageTools()