Package oracle.as.scheduler.request

Class RemoteContentHelper

java.lang.Object

oracle.as.scheduler.request.RemoteContentHelper

public class RemoteContentHelper
extends Object

Log and output helper for remote EJB job.

Constructor Summary

Constructors

Constructor	Description
RemoteContentHelper(RequestExecutionContext context, RequestParameters params)	Creates a remote helper for request content.
RemoteContentHelper(RequestExecutionContext context, RequestParameters params, RuntimeService runtime)	Creates a remote helper for request content using the given RuntimeService.

Method Summary

Modifier and Type	Method	Description
void	closeOutputContent(ContentHandle contentHandle)	Closes the content associated with the given content handle.
boolean	copyBinaryContentToFile(ContentHandle contentHandle, File file, boolean lockRow)	Copy binary content of the given request to file.
boolean	copyTextContentToFile(ContentHandle contentHandle, File file, boolean lockRow)	Copy log or output text content of the given request to file.
void	deleteOutputContent(String contentName)	Deletes the request output content from the content store, if it exists.
void	deleteOutputContent(List<String> contentNames)	Deletes the list of request output content from the content store, if it exists.
byte[]	getBinaryContent(ContentHandle contentHandle, int maxBytes)	Gets at most maxBytes bytes from the binary content.
byte[]	getBinaryContent(ContentHandle contentHandle, int maxBytes, boolean lockRow)	Gets at most maxBytes bytes from the binary content.
Blob	getBinaryContentLob(ContentHandle contentHandle)	Gets the binary content.
List<ContentDetail>	getOutputContentDetail()	Gets details for all output content for the request.
ContentDetail	getOutputContentDetail(String contentName)	Gets details for the specified output content for the request.
RequestExecutionContext	getRequestExecutionContext()	Gets the request execution content for this helper.
RuntimeService	getRuntimeService()	Gets the RuntimeService used by this helper.
char[]	getTextContent(ContentHandle contentHandle, int maxChars)	Gets at most maxChars characters from the text output content.
char[]	getTextContent(ContentHandle contentHandle, int maxChars, boolean lockRow)	Gets at most maxChars characters from the text output content.
Clob	getTextContentLob(ContentHandle contentHandle)	Gets the text output content.
void	log(Level level, String message)	Logs the message at the given level.
ContentHandle	openOutputContent(RuntimeServiceHandle runtimeHandle, String contentName, ContentType contentType, EnumSet<ContentHandle.ContentOpenOptions> options)	Opens output content for read or write.
boolean	outputContentExists(String contentName)	Determines if the output content exists for the request.
void	write(ContentHandle contentHandle, byte[] data)	Appends the bytes to the output content during job execution.
void	write(ContentHandle contentHandle, char[] data)	Appends the characters to the output content during job execution.
void	write(ContentHandle contentHandle, String data)	Appends the string to the output content during job execution.
void	writeln(ContentHandle contentHandle, String data)	Appends the string followed by a line feed character to the output content during job execution.

Methods inherited from class java.lang.Object

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

Constructor Details

RemoteContentHelper

public RemoteContentHelper(RequestExecutionContext context,
 RequestParameters params)
                    throws NamingException,
SchedulerException

Creates a remote helper for request content. This gets and associates a RuntimeService object using the request parameters.

Parameters:

context - request execution context passed to the job executable.

params - request parameters passed to the job executable.

Throws:

NamingException - if error setting up initial context for remote RuntimeService lookup.

SchedulerException - if unable to perform JNDI lookup of remote RuntimeService.

RemoteContentHelper

public RemoteContentHelper(RequestExecutionContext context,
 RequestParameters params,
 RuntimeService runtime)
                    throws SchedulerException

Creates a remote helper for request content using the given RuntimeService.

Parameters:

context - request execution context passed to the job executable.

params - request parameters passed to the job executable.

runtime - remote runtime service EJB for log/output.

Throws:

SchedulerException

Method Details

log

public void log(Level level,
 String message)
         throws RequestNotFoundException,
RuntimeServiceException

Logs the message at the given level.

Parameters:

level - log level for the message.

message - message to log.

Throws:

RequestNotFoundException - if request does not exist.

RuntimeServiceException - if runtime service subsystem error.

openOutputContent

public ContentHandle openOutputContent(RuntimeServiceHandle runtimeHandle,
 String contentName,
 ContentType contentType,
 EnumSet<ContentHandle.ContentOpenOptions> options)
                                throws NotFoundException,
RequestNotFoundException,
RuntimeServiceException,
ValidationException

Opens output content for read or write. For a write, the content will be created if necessary.

closeOutputContent must be called after finished reading or writing of the content. The runtimeHandle is cached while the content is open and that handle must remain open and valid through closeOutputContent.

Parameters:

runtimeHandle - runtime service handle from previous open call.

contentName - name of the output content.

contentType - type of the output content. ContentType.Unknow can be passed.

options - an EnumSet<ContentOpenOptions> of options specifying how to open the request output.

Returns:

Content handle for write operations.

Throws:

NotFoundException - if the content for read does not exist.

RequestNotFoundException - if the request does not exist.

RuntimeServiceException - if runtime service subsystem error.

ValidationException - if the write is invalid.

closeOutputContent

public void closeOutputContent(ContentHandle contentHandle)
                        throws IllegalArgumentException,
RequestNotFoundException,
RuntimeServiceException

Closes the content associated with the given content handle.

The runtime service handle that was passed to openOutputContent can be closed upon return from this method.

Parameters:

contentHandle - content handle from previous call to openOutputContent.

Throws:

IllegalArgumentException - if handle is invalid.

RequestNotFoundException - if the request was not found.

RuntimeServiceException - if runtime service subsystem error.

writeln

public void writeln(ContentHandle contentHandle,
 String data)
             throws IllegalArgumentException,
NotFoundException,
RuntimeServiceException,
ValidationException

Appends the string followed by a line feed character to the output content during job execution.

The content must be open for write, and the runtime service handle that was passed to openOutputContent must be valid.

Parameters:

contentHandle - content handle from previous call to openOutputContent.

data - string to write to the output content, followed by line feed character.

Throws:

IllegalArgumentException - if the content handle is invalid.

NotFoundException - if the content does not exist.

RuntimeServiceException - if runtime service subsystem error.

ValidationException - if it is invalid to write to the content, meaning the content type is binary or the content was created from an import.

write

public void write(ContentHandle contentHandle,
 String data)
           throws IllegalArgumentException,
NotFoundException,
RuntimeServiceException,
ValidationException

Appends the string to the output content during job execution.

The content must be open for write, and the runtime service handle that was passed to openOutputContent must be valid.

Parameters:

contentHandle - content handle from previous call to openOutputContent.

data - string to write to the output content.

Throws:

IllegalArgumentException - if content handle is invalid.

NotFoundException - if content does not exist.

RuntimeServiceException - if runtime service subsystem error.

ValidationException - if it is invalid to write to the content, meaning the content type is binary or the content was created from an import.

write

public void write(ContentHandle contentHandle,
 char[] data)
           throws IllegalArgumentException,
NotFoundException,
RuntimeServiceException,
ValidationException

Appends the characters to the output content during job execution.

The content must be open for write, and the runtime service handle that was passed to openOutputContent must be valid.

Parameters:

contentHandle - content handle from previous call to openOutputContent.

data - characters to append.

Throws:

IllegalArgumentException - if content handle is invalid.

NotFoundException - if content does not exist.

RuntimeServiceException - if runtime service subsystem error.

ValidationException - if it is invalid to write to the content, meaning the content type is binary or the content was created from an import.

write

public void write(ContentHandle contentHandle,
 byte[] data)
           throws IllegalArgumentException,
NotFoundException,
RuntimeServiceException,
ValidationException

Appends the bytes to the output content during job execution.

The content must be open for write, and the runtime service handle that was passed to openOutputContent must be valid.

Parameters:

contentHandle - content handle from previous call to openOutputContent.

data - bytes to append.

Throws:

IllegalArgumentException - if content handle is invalid.

NotFoundException - if content does not exist.

RuntimeServiceException - if runtime service subsystem error.

ValidationException - if it is invalid to write to the content, meaning the content type is binary or the content was created from an import.

getBinaryContent

public byte[] getBinaryContent(ContentHandle contentHandle,
 int maxBytes)
                        throws IllegalArgumentException,
RequestNotFoundException,
RuntimeServiceException,
ValidationException

Gets at most maxBytes bytes from the binary content.

The content must be open for read, and the runtime service handle that was passed to openOutputContent must be valid.

Parameters:

contentHandle - content handle from previous open call.

maxBytes - maximum number of bytes to get.

Returns:

array of bytes from the content.

Throws:

IllegalArgumentException - if handle is invalid.

RequestNotFoundException - if the request was not found

RuntimeServiceException - if runtime service subsystem error.

ValidationException

getBinaryContent

public byte[] getBinaryContent(ContentHandle contentHandle,
 int maxBytes,
 boolean lockRow)
                        throws IllegalArgumentException,
RequestNotFoundException,
RuntimeServiceException,
ValidationException

Gets at most maxBytes bytes from the binary content.

The content must be open for read, and the runtime service handle that was passed to openOutputContent must be valid.

Parameters:

contentHandle - content handle from previous open call.

maxBytes - maximum number of bytes to get.

lockRow - the row will be locked if true.

Returns:

array of bytes from the content.

Throws:

IllegalArgumentException - if handle is invalid.

RequestNotFoundException - if the request was not found

RuntimeServiceException - if runtime service subsystem error.

ValidationException

copyBinaryContentToFile

public boolean copyBinaryContentToFile(ContentHandle contentHandle,
 File file,
 boolean lockRow)
                                throws IllegalArgumentException,
RuntimeServiceException,
RequestNotFoundException

Copy binary content of the given request to file.

Parameters:

contentHandle - content handle from previous open call.

file - File to which content has to be copied.

lockRow - the row will be locked if true.

Returns:

boolean true if copy is successful, else false.

Throws:

IllegalArgumentException - if handle is invalid.

RuntimeServiceException - if runtime service sub-system error.

RequestNotFoundException - if the request was not found.

getTextContent

public char[] getTextContent(ContentHandle contentHandle,
 int maxChars)
                      throws IllegalArgumentException,
RuntimeServiceException,
RequestNotFoundException

Gets at most maxChars characters from the text output content.

The content must be open for read, and the runtime service handle that was passed to openOutputContent must be valid.

Parameters:

contentHandle - content handle from previous call to openOutputContent.

maxChars - maximum number of characters to get.

Returns:

array of uninterpreted characters from the content.

Throws:

IllegalArgumentException - if handle is invalid.

RuntimeServiceException - if runtime service subsystem error.

RequestNotFoundException - if the request was not found

getTextContent

public char[] getTextContent(ContentHandle contentHandle,
 int maxChars,
 boolean lockRow)
                      throws IllegalArgumentException,
RuntimeServiceException,
RequestNotFoundException

Gets at most maxChars characters from the text output content.

The content must be open for read, and the runtime service handle that was passed to openOutputContent must be valid.

Parameters:

contentHandle - content handle from previous call to openOutputContent.

maxChars - maximum number of characters to get.

lockRow - the row will be locked if true.

Returns:

array of uninterpreted characters from the content.

Throws:

IllegalArgumentException - if handle is invalid.

RuntimeServiceException - if runtime service subsystem error.

RequestNotFoundException - if the request was not found

copyTextContentToFile

public boolean copyTextContentToFile(ContentHandle contentHandle,
 File file,
 boolean lockRow)
                              throws IllegalArgumentException,
RuntimeServiceException,
RequestNotFoundException

Copy log or output text content of the given request to file.

Parameters:

contentHandle - content handle from previous open call.

file - File to which content has to be copied.

lockRow - the row will be locked if true.

Returns:

boolean true if copy is successful, else false.

Throws:

IllegalArgumentException - if handle is invalid.

RuntimeServiceException - if runtime service sub-system error.

RequestNotFoundException - if the request was not found.

outputContentExists

public boolean outputContentExists(String contentName)
                            throws RequestNotFoundException,
RuntimeServiceException

Determines if the output content exists for the request.

Parameters:

contentName - name of output content.

Returns:

true if the content exists; false if the content does not exist.

Throws:

RequestNotFoundException - if the request was not found

RuntimeServiceException - if runtime service subsystem error.

getOutputContentDetail

public ContentDetail getOutputContentDetail(String contentName)
                                     throws RuntimeServiceException,
RequestNotFoundException

Gets details for the specified output content for the request.

Parameters:

contentName - name of output content.

Returns:

Details of the specified output content, or null if the content does not exist.

Throws:

RuntimeServiceException - if runtime service subsystem error.

RequestNotFoundException - if the request was not found

getOutputContentDetail

public List<ContentDetail> getOutputContentDetail()
                                           throws RequestNotFoundException,
RuntimeServiceException

Gets details for all output content for the request.

Returns:

List<ContentDetail> of details for all output content for the request. The list will be empty if there is no output content.

Throws:

RequestNotFoundException - if the request was not found

RuntimeServiceException - if runtime service subsystem error.

deleteOutputContent

public void deleteOutputContent(List<String> contentNames)
                         throws RequestNotFoundException,
RuntimeServiceException

Deletes the list of request output content from the content store, if it exists. This can delete all output content for the request, including content that was created with the API or that was imported.

Parameters:

contentNames - List<String> of names of output content.

Throws:

RequestNotFoundException - if the request was not found

RuntimeServiceException - if runtime service subsystem error.

deleteOutputContent

public void deleteOutputContent(String contentName)
                         throws RequestNotFoundException,
RuntimeServiceException

Deletes the request output content from the content store, if it exists. The content may have been created with the API or have been imported.

Parameters:

contentName - name of output content.

Throws:

RequestNotFoundException - if the request was not found

RuntimeServiceException - if runtime service subsystem error.

getRuntimeService

public RuntimeService getRuntimeService()

Gets the RuntimeService used by this helper.

Returns:

runtime service object

getRequestExecutionContext

public RequestExecutionContext getRequestExecutionContext()

Gets the request execution content for this helper.

Returns:

request execution context.

getBinaryContentLob

public Blob getBinaryContentLob(ContentHandle contentHandle)
                         throws IllegalArgumentException,
RequestNotFoundException,
RuntimeServiceException,
ValidationException

Gets the binary content.

The content must be open for read, and the runtime service handle that was passed to openOutputContent must be valid.

Parameters:

contentHandle - content handle from previous open call.

Returns:

Blob from the content.

Throws:

IllegalArgumentException - if handle is invalid.

RequestNotFoundException - if the request was not found

RuntimeServiceException - if runtime service subsystem error.

ValidationException

getTextContentLob

public Clob getTextContentLob(ContentHandle contentHandle)
                       throws IllegalArgumentException,
RuntimeServiceException,
RequestNotFoundException

Gets the text output content.

The content must be open for read, and the runtime service handle that was passed to openOutputContent must be valid.

Parameters:

contentHandle - content handle from previous call to openOutputContent.

Returns:

Clob of uninterpreted characters from the content.

Throws:

IllegalArgumentException - if handle is invalid.

RuntimeServiceException - if runtime service subsystem error.

RequestNotFoundException - if the request was not found