Index

Object PCRE.RepositoryCOMClient

proxy_process

 

r_shrOrb

 

createFolderInRepository(String, RepositorySecurityOptions, RepositorySecurityOptions, RepositoryExpirationOptions)

Creates a new folder in the repository with the given attributes.

deleteDorDataInRepository(String)

Delete the data file from the repository.

deleteFolderInRepository(String)

Deletes a folder and its recursive contents from the repository.

deleteOutputFromRepository(String)

Delete the single output file from the repository.

folderExists(String)

Used to test for the existence of the repository folder.

getOrb()

 

getOutputFolderContentsFromRepository(String, String)

Retrieves the output folder and all recursive contents from the repository and writes it to the client machine in the client machine folder specified.

getOutputFromRepository(String, String)

Retrieves the single output file from the repository and writes it to the client machine at the path specified.

getOutputFromRepositoryAsStream(String)

Retrieves the single output file from the repository and as an input stream.

getPoa()

 

logInRepository(String, String)

Used to log the given user into the repository.

logOutRepository()

Should be called in order to free resources when the user is finished using the RepositoryClient object to interact with the repository.

storeXmlDataInRepository(String, String, RepositorySecurityOptions, RepositoryExpirationOptions, boolean)

Stores the data object into the repository for later use as a data source for a report.

Process proxy_process

ORB r_shrOrb

ORB getOrb()

POA getPoa()

boolean folderExists(String folderPath)

          Used to test for the existence of the repository folder.

Parameters:

folderPath - The full path to the folder in question.

void createFolderInRepository(String repositoryPath,
                              RepositorySecurityOptions folderSecOptions,
                              RepositorySecurityOptions defaultFileSecOptions,
                              RepositoryExpirationOptions expirationOptions)

          Creates a new folder in the repository with the given attributes.

Parameters:

repositoryPath - full pathname for the folder to be created.

folderSecOptions - the security attributes of the new folder.

defaultFileSecOptions - the security attributes which a contained file or folder will have if not specified during creation of the contained file or folder.

expirationInfo - the expiration attributes of the new folder.

void deleteFolderInRepository(String repositoryPath)

          Deletes a folder and its recursive contents from the repository. This operation has atomic behavior which means that it will either totally succeed with the folder and all recursive contents deleted, or will fail with the folder and all recursive contents remaining.

Parameters:

repositoryPath - full pathname for the folder to be deleted.

void getOutputFromRepository(String repositoryPath,
                             String clientPath)

          Retrieves the single output file from the repository and writes it to the client machine at the path specified.

Parameters:

repositoryPath - full pathname to the output to be retrieved.

clientPath - full pathname to the location on the client machine to write the output.

InputStream getOutputFromRepositoryAsStream(String repositoryPath)

          Retrieves the single output file from the repository and as an input stream.

Parameters:

repositoryPath - full pathname to the output to be retrieved.

void deleteOutputFromRepository(String repositoryPath)

          Delete the single output file from the repository.

Parameters:

repositoryPath - full pathname to the output to be deleted.

void storeXmlDataInRepository(String repositoryPath,
                              String xmlFilePath,
                              RepositorySecurityOptions dataSecOptions,
                              RepositoryExpirationOptions expirationOptions,
                              boolean overwrite)

          Stores the data object into the repository for later use as a data source for a report.

Parameters:

repositoryPath - full pathname for the data object in the repository.

xmlFilePath - the client machine path to an XML file. Used by Dynalivery customers who are using the COM client.

dataSecOptions - the security attributes for the data.

expirationOptions - the expiration attributes for the data.

overwrite - true if desire to overwrite data with the same path in the repository.

void deleteDorDataInRepository(String repositoryPath)

          Delete the data file from the repository.

Parameters:

repositoryPath - full pathname to the data to be deleted.

void getOutputFolderContentsFromRepository(String repositoryFolder,
                                           String clientDirectory)

          Retrieves the output folder and all recursive contents from the repository and writes it to the client machine in the client machine folder specified. The name of all contents and the folder structure is maintained. This method does not have atomic behavior and may result in a partial retrieval of contents before an exception is thrown.

Parameters:

repositoryFolder - full pathname to the output folder to be retrieved.

clientDirectory - full pathname to the directory on the client machine to write the output.

void logInRepository(String username,
                     String password)

          Used to log the given user into the repository. Only one user may be logged in to a given RepositoryClient object at any time. If this method is called after a user has already logged in, then the current user will be logged out before the new user is logged in.

Parameters:

username - The username which exists in the security realm of the Web Application Server in which the repository is running.

password - The corresponding password for this user.

void logOutRepository()

          Should be called in order to free resources when the user is finished using the RepositoryClient object to interact with the repository.

Index