|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.rational.rpe.api.docgen.RemoteDocumentGenerator
public class RemoteDocumentGenerator
Utility class for running reports using a remote web service instance. For publishing reports locally see LocalDocumentGenerator
.
Constructor Summary | |
---|---|
RemoteDocumentGenerator(Credential credential,
java.lang.String jobURI)
Constructs a new RemoteDocumentGenerator instance that connects to the given server. |
|
RemoteDocumentGenerator(java.lang.String serverAddress,
Credential credential)
Constructs a new RemoteDocumentGenerator instance that connects to the given server. |
Method Summary | |
---|---|
void |
addStatusListener(RPEListener listener)
Deprecated. |
java.lang.Thread |
connectToJob(java.lang.String job)
Connects to an existing job. |
com.ibm.rational.rpe.engine.RRDGEngine.EngineStatus |
connectToJobSynch(java.lang.String job)
Connects to an existing job and waits until the job is completed. |
java.lang.String |
downloadResult()
Downloads the results archive. |
void |
enableDebug(boolean debug)
See IDocumentGenerator.enableDebug(boolean) |
java.lang.String |
getConfigurationPath(java.net.URI path)
Deprecated. |
java.lang.String |
getJobURI()
Returns the URI of the job to which this generator is attached. |
java.net.URI |
getLog()
Returns the URI of the server log file for the remote document generation process. |
java.lang.String |
getOwner()
Returns the user name that started the remote document generator. |
java.net.URI |
getResultArchive()
This method provides a URI to an archive containing all the output files requested in the Document Specification, once a publishing
process has ended successfully. |
java.net.URL |
getResultPage()
Deprecated. |
java.util.List<RPEResult> |
getResults()
Retrieves the results of a publishing process. |
java.lang.String |
getScheduleUrl()
Specifies the schedule URL if the job being executed was triggered through the report scheduler |
java.lang.String |
getServerAddress()
Retrieves the server address used for the remote publishing process. |
com.ibm.rational.rpe.engine.RRDGEngine.EngineStatus |
getStatus()
See IDocumentGenerator.getStatus() |
void |
pause()
'Pause' functionality is not implemented for RemoteDocumentGenerator |
java.lang.Thread |
publish(RPEDocumentSpecification docSpec)
Deprecated. |
java.lang.Thread |
publish(RPEDocumentSpecification docSpec,
int previewQueryLimit)
Starts the publishing process for the given Document Specification and returns the thread that monitors the remote execution. |
void |
publishSync(RPEDocumentSpecification docSpec)
Deprecated. |
com.ibm.rational.rpe.engine.RRDGEngine.EngineStatus |
publishSync(RPEDocumentSpecification docSpec,
int previewQueryLimit)
Starts the publishing process for a given Document Specification in the calling thread. |
java.net.URI |
readJobLogURI()
Reads the log URI for the current job from the server. |
java.net.URI |
readJobResultsURI()
Reads the log results URI for the current job from the server. |
java.lang.String |
readJobStatus()
Reads the status for the current job from the server. |
void |
registerListener(RPEListener listener)
See IDocumentGenerator.registerListener(RPEListener) |
void |
removeStatusListener(RPEListener listener)
Deprecated. |
void |
resume()
'Resume' functionality is not implemented for RemoteDocumentGenerator |
void |
setOwner(java.lang.String owner)
Specifies the actual user on behalf of whom the docgen is executed. |
void |
setScheduleUrl(java.lang.String scheduleUrl)
Internal |
void |
setServerAddress(java.lang.String serverAddress)
Sets the server address to use for the remote publishing process. |
void |
stop()
Stops a running publishing process. |
void |
unregisterListener(RPEListener listener)
See IDocumentGenerator.unregisterListener(RPEListener) |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public RemoteDocumentGenerator(java.lang.String serverAddress, Credential credential)
serverAddress
- a String containing a URL to the web service resource. Provide
the full path to the web service description, for example:
"http://server[:port]/rpews/"credential
- the Credential
information to use when connecting to the service. Optionalpublic RemoteDocumentGenerator(Credential credential, java.lang.String jobURI)
serverAddress
- the URL of the job to connect to. Example: http://server[:port]/rpews/monitor/jobs/7c6dd6ac-5fa1-4a7b-91dd-be7209e256eecredential
- the Credential
information to use when connecting to the service. OptionalMethod Detail |
---|
public java.lang.String getJobURI()
public java.net.URI getLog()
public java.net.URI readJobLogURI() throws RPEException, java.net.URISyntaxException
getLog()
should be called first and if it returns null this method can then be used.
RPEException
java.net.URISyntaxException
public java.net.URI readJobResultsURI() throws RPEException, java.net.URISyntaxException
RPEException
java.net.URISyntaxException
public java.lang.String readJobStatus() throws RPEException
RPEException
java.net.URISyntaxException
@Deprecated public java.lang.String getConfigurationPath(java.net.URI path)
public void enableDebug(boolean debug)
IDocumentGenerator.enableDebug(boolean)
enableDebug
in interface IDocumentGenerator
public void setServerAddress(java.lang.String serverAddress)
serverAddress
- a String containing a URL to the web service resource. Provide
the full path to the web service description, for example:
"http://server[:port]/rpe/services/RPEService?wsdl"public java.lang.String getServerAddress()
public void pause()
pause
in interface IControl
public void resume()
resume
in interface IControl
public void stop()
stop
in interface IControl
public java.net.URI getResultArchive()
URI
to an archive containing all the output files requested in the Document Specification, once a publishing
process has ended successfully.
public java.lang.String downloadResult() throws AuthenticationException, java.io.IOException
AuthenticationException
java.io.IOException
public com.ibm.rational.rpe.engine.RRDGEngine.EngineStatus publishSync(RPEDocumentSpecification docSpec, int previewQueryLimit) throws RPEException
publish(RPEDocumentSpecification)
should be used when the calling thread is not to be blocked.
Status messages regarding the progress are passed to the registered listeners.
NOTE: This method does not return until the publishing thread has ended its execution.
publishSync
in interface IDocumentGenerator
docSpec
- the Document Specification to be published
RPEException
public java.lang.Thread connectToJob(java.lang.String job) throws RPEException
job
- the URI of the job to connect to
RPEException
public com.ibm.rational.rpe.engine.RRDGEngine.EngineStatus connectToJobSynch(java.lang.String job) throws RPEException
job
- the URI of the job to connect to
RPEException
public java.lang.Thread publish(RPEDocumentSpecification docSpec, int previewQueryLimit) throws RPEException
Status messages regarding the progress are passed to the registered listeners.
This method returns immediately after it has been called. The returning
Thread
object can be used to determine when the publish process
has ended.
publish
in interface IDocumentGenerator
docSpec
- the Document Specification to be published
Thread
RPEException
public void registerListener(RPEListener listener)
IDocumentGenerator.registerListener(RPEListener)
registerListener
in interface IDocumentGenerator
public void unregisterListener(RPEListener listener)
IDocumentGenerator.unregisterListener(RPEListener)
unregisterListener
in interface IDocumentGenerator
@Deprecated public java.net.URL getResultPage()
@Deprecated public void addStatusListener(RPEListener listener)
registerListener(com.ibm.rational.rpe.api.docspec.RPEListener)
@Deprecated public void removeStatusListener(RPEListener listener)
unregisterListener(com.ibm.rational.rpe.api.docspec.RPEListener)
@Deprecated public java.lang.Thread publish(RPEDocumentSpecification docSpec) throws RPEException
publish(RPEDocumentSpecification, int)
RPEException
@Deprecated public void publishSync(RPEDocumentSpecification docSpec) throws RPEException
publishSync(RPEDocumentSpecification, int)
RPEException
public java.util.List<RPEResult> getResults()
RESULT_TYPE_ARCHIVE
or RESULT_TYPE_LOG
)
getResults
in interface IDocumentGenerator
public com.ibm.rational.rpe.engine.RRDGEngine.EngineStatus getStatus()
IDocumentGenerator.getStatus()
getStatus
in interface IDocumentGenerator
public java.lang.String getOwner()
public void setOwner(java.lang.String owner)
owner
- public java.lang.String getScheduleUrl()
owner
- public void setScheduleUrl(java.lang.String scheduleUrl)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |