|
|||||||||||
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, also
for other operations available. For publishing reports using a local
instance, see LocalDocumentGenerator
.
Constructor Summary | |
---|---|
RemoteDocumentGenerator(Credential credential,
java.lang.String jobURI)
|
|
RemoteDocumentGenerator(java.lang.String serverAddress,
Credential credential)
Constructor for class RemoteDocumentGenerator |
Method Summary | |
---|---|
void |
addStatusListener(RPEListener listener)
Deprecated. |
java.lang.Thread |
connectToJob(java.lang.String job)
Connects to an existing job and returns a thread like the publish method does |
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 using the credentials provided in the constructor |
void |
enableDebug(boolean debug)
Enables the core debug mode for the document generation |
java.lang.String |
getConfigurationPath(java.net.URI path)
Retrieves the path to the configuration file that needs to be passed to DocumentSpecificationBuilder methods. |
java.lang.String |
getJobURI()
|
java.net.URI |
getLog()
|
java.lang.String |
getOwner()
|
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 currently used for the remote publishing process. |
com.ibm.rational.rpe.engine.RRDGEngine.EngineStatus |
getStatus()
Returns the status of the generation |
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 a given Document Specification. |
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. |
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)
Registers a RPE listener for receiving important progress messages from the document generation |
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)
|
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)
Unregisters the listener from the engine |
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]/rpe/services/RPEService?wsdl"public RemoteDocumentGenerator(Credential credential, java.lang.String jobURI)
Method Detail |
---|
public java.lang.String getJobURI()
public java.net.URI getLog()
public java.net.URI readJobLogURI() throws RPEException, java.net.URISyntaxException
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
public java.lang.String getConfigurationPath(java.net.URI path)
DocumentSpecificationBuilder
methods.
path
- an URI
consisting of a path to the configuration
folder. If this parameter is null, this method returns a path
computed based on the "RPE_HOME" system environment variable.
public void enableDebug(boolean debug)
IDocumentGenerator
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 com.ibm.rational.rpe.common.auth.AuthenticationException, java.io.IOException
com.ibm.rational.rpe.common.auth.AuthenticationException
java.io.IOException
public com.ibm.rational.rpe.engine.RRDGEngine.EngineStatus publishSync(RPEDocumentSpecification docSpec, int previewQueryLimit) throws RPEException
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
-
RPEException
public com.ibm.rational.rpe.engine.RRDGEngine.EngineStatus connectToJobSynch(java.lang.String job) throws RPEException
job
-
RPEException
public java.lang.Thread publish(RPEDocumentSpecification docSpec, int previewQueryLimit) throws RPEException
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
in interface IDocumentGenerator
public void unregisterListener(RPEListener listener)
IDocumentGenerator
unregisterListener
in interface IDocumentGenerator
@Deprecated public java.net.URL getResultPage()
URL
to a HTML page that presents a link to
the result archive file, once a publishing process has ended
successfully.
@Deprecated public void addStatusListener(RPEListener listener)
@Deprecated public void removeStatusListener(RPEListener listener)
@Deprecated public java.lang.Thread publish(RPEDocumentSpecification docSpec) throws RPEException
RPEException
@Deprecated public void publishSync(RPEDocumentSpecification docSpec) throws RPEException
RPEException
public java.util.List<RPEResult> getResults()
getResults
in interface IDocumentGenerator
public com.ibm.rational.rpe.engine.RRDGEngine.EngineStatus getStatus()
IDocumentGenerator
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 |