PageBoxLib
Interface DeployIF

All Superinterfaces:

java.rmi.Remote, TokenIF

All Known Subinterfaces:

DeployerIF

All Known Implementing Classes:

Deployer, DeployImpl, HTTPDeployer, JWSDPDeployer

public interface DeployIF

extends TokenIF, java.rmi.Remote

Interface of the deployment Web Service.

Changes:

• 0.0.7: PageBox user and password added to UrlUser class
• 0.0.8: getLog method
• 0.0.9: Status class
• 0.0.10: downloadURL on getAudit
• 0.0.11: oldDate on add; extends tokenIF

alexis.grandemange@pagebox.net

Copyright (c) 2002-2004 Alexis Grandemange

This program is free software; you can redistribute it and/or
 modify it under the terms of the GNU Lesser General Public License
 as published by the Free Software Foundation; version 2.1 of the
 License.
 This library is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 GNU Lesser General Public License for more details.
 A copy of the GNU Lesser General Public License lesser.txt should be
 included in the distribution.

Version:

0, 0, 11

Author:

Alexis Grandemange

Nested Class Summary

static class	DeployIF.Status Classe wrapping the deployment code and message.
static class	DeployIF.UrlUser Class wrapping the url and user of a subscriber.

Method Summary

DeployIF.Status	add(java.lang.String arch, java.lang.String downloadURL, java.lang.String owner, byte[] archData, java.lang.String date, java.lang.String oldDate, java.lang.String docURL, java.lang.String user, boolean isUpdate, boolean runInstall, DeployIF.UrlUser[] relayed) Deploys an archive and returns a status.
DeployIF.Status	delete(java.lang.String arch, java.lang.String downloadURL, java.lang.String owner, java.lang.String user, boolean runRemove, boolean keepDir) Undeploys an archive and returns a status.
java.lang.String	getArchPath(java.lang.String arch) Returns an archive path: The URL of archive pages is normally /rootPath/archive_without_extension.
java.lang.String	getAudit(java.lang.String arch, java.lang.String owner, java.lang.String user, java.lang.String downloadURL) Returns the audit entries specific to an archive on a PageBox
java.lang.String	rename(java.lang.String oldDownloadURL, java.lang.String newDownloadURL, java.lang.String user) Change the repository URL.

Methods inherited from interface PageBoxLib.TokenIF

frameSend

Method Detail

add

public DeployIF.Status add(java.lang.String arch,
                           java.lang.String downloadURL,
                           java.lang.String owner,
                           byte[] archData,
                           java.lang.String date,
                           java.lang.String oldDate,
                           java.lang.String docURL,
                           java.lang.String user,
                           boolean isUpdate,
                           boolean runInstall,
                           DeployIF.UrlUser[] relayed)
                    throws java.rmi.RemoteException

Deploys an archive and returns a status.

Parameters:

arch - archive name.

downloadURL - download URL.

owner - user who published the archive.

archData - archive data.

date - publication date and time.

oldDate - publication date and time.

docURL - documentation URL.

user - user who subscribed the PageBox.

isUpdate - if true delta update.

runInstall - if true run the Application server installer (Web application).

relayed - PageBox instances to deploy.

Returns:

Status object.

Throws:

java.rmi.RemoteException

delete

public DeployIF.Status delete(java.lang.String arch,
                              java.lang.String downloadURL,
                              java.lang.String owner,
                              java.lang.String user,
                              boolean runRemove,
                              boolean keepDir)
                       throws java.rmi.RemoteException

Undeploys an archive and returns a status.

Parameters:

arch - archive name.

downloadURL - download URL.

owner - user who published the archive.

user - user who subscribed the PageBox.

runRemove - if true run the Application server installer (Web application)

keepDir - keep directory

Returns:

Status object

Throws:

java.rmi.RemoteException

rename

public java.lang.String rename(java.lang.String oldDownloadURL,
                               java.lang.String newDownloadURL,
                               java.lang.String user)
                        throws java.rmi.RemoteException

Change the repository URL.

Parameters:

oldDownloadURL - previous download URL for some archives

newDownloadURL - new download URL for these archives

user - user who subscribed the PageBox.

Returns:

status.

Throws:

java.rmi.RemoteException

getArchPath

public java.lang.String getArchPath(java.lang.String arch)
                             throws java.rmi.RemoteException

Returns an archive path: The URL of archive pages is normally /rootPath/archive_without_extension. Method added for the PageBox API support.

Parameters:

arch - archive name

Returns:

URL of archive pages

Throws:

java.rmi.RemoteException

getAudit

public java.lang.String getAudit(java.lang.String arch,
                                 java.lang.String owner,
                                 java.lang.String user,
                                 java.lang.String downloadURL)
                          throws java.rmi.RemoteException

Returns the audit entries specific to an archive on a PageBox

Parameters:

arch - archive name

owner - user who published the archive.

user - user who subscribed the PageBox.

downloadURL - download URL.

Returns:

audit entries

Throws:

java.rmi.RemoteException