|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.deployment.file.FileDeploymentData
public class FileDeploymentData
FileDeploymentData is used to generate a list of files for deployment.
To signal that a file is to be added use the addNewFile()
method.
To signal that a file is to be updated use the addFileForUpdate()
method.
To signal that an item is to be deleted, use the addFileForDelete()
method.
This class is NOT threadsafe and should not be used by multiple threads.
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
static java.lang.String |
FILE_TYPE
|
java.util.LinkedHashMap |
mFileURIsToAddInput
|
java.util.LinkedHashMap |
mFileURIsToAddRollbackInput
|
java.util.LinkedHashMap |
mFileURIsToDeleteInput
|
java.util.LinkedHashMap |
mFileURIsToDeleteRollbackInput
|
java.util.LinkedHashMap |
mFileURIsToUpdateInput
|
java.util.LinkedHashMap |
mFileURIsToUpdateRollbackInput
|
static java.lang.String |
PATH_PREFIX
|
static java.lang.String |
URI_PREFIX
|
Constructor Summary | |
---|---|
FileDeploymentData(VirtualFileSystem pSourceFileSystem,
FileDeploymentDestination pDestination)
|
|
FileDeploymentData(VirtualFileSystem pSourceFileSystem,
FileDeploymentDestination pDestination,
java.lang.String pDestinationFileSystemPath)
|
Method Summary | |
---|---|
void |
addFileForDelete(VirtualFile pFile)
Convenience method for adding a file for deletion from the destination |
void |
addFileForDelete(VirtualFile pFile,
java.lang.String pForwardSourceDevelopmentLineID,
java.lang.String pRollbackSourceDevelopmentLineID)
Convenience method for adding a file for deletion from the destination |
void |
addFileForDeleteByFileString(java.lang.String pFileString)
Convenience method for adding a file for deletion from the destination This method does not validate the existence of the file in the source VFS. |
void |
addFileForDeleteByFileString(java.lang.String pFileString,
java.lang.String pForwardSourceDevelopmentLineID,
java.lang.String pRollbackSourceDevelopmentLineID)
Convenience method for adding a file for deletion from the destination This method does not validate the existence of the file in the source VFS. |
void |
addFileForDeleteByPath(java.lang.String pFilePath)
Convenience method for adding a file for deletion from the destination This method does not validate the existence of the file in the source VFS. |
void |
addFileForDeleteByPath(java.lang.String pFilePath,
java.lang.String pForwardSourceDevelopmentLine,
java.lang.String pRollbackSourceDevelopmentLineID)
Convenience method for adding a file for deletion from the destination This method does not validate the existence of the file in the source VFS. |
void |
addFileForDeleteByURI(java.lang.String pFileURI)
Convenience method for adding a file for deletion from the destination This method does not validate the existence of the file in the source VFS. |
void |
addFileForDeleteByURI(java.lang.String pFileURI,
java.lang.String pForwardSourceDevelopmentLine,
java.lang.String pRollbackSourceDevelopmentLineID)
Convenience method for adding a file for deletion from the destination This method does not validate the existence of the file in the source VFS. |
void |
addFileForUpdate(VirtualFile pFile)
Convenience method for adding a file for update to the destination |
void |
addFileForUpdate(VirtualFile pFile,
java.lang.String pForwardSourceDevelopmentLineID,
java.lang.String pRollbackSourceDevelopmentLineID)
Convenience method for adding a file for update to the destination |
void |
addFileForUpdateByFileString(java.lang.String pFileString)
Convenience method for adding a file for update to the destination This method does not validate the existence of the file in the source VFS. |
void |
addFileForUpdateByFileString(java.lang.String pFileString,
java.lang.String pForwardSourceDevelopmentLineID,
java.lang.String pRollbackSourceDevelopmentLineID)
Convenience method for adding a file for update to the destination This method does not validate the existence of the file in the source VFS. |
void |
addFileForUpdateByPath(java.lang.String pFilePath)
Convenience method for adding a file for update to the destination This method does not validate the existence of the file in the source VFS. |
void |
addFileForUpdateByPath(java.lang.String pFilePath,
java.lang.String pForwardSourceDevelopmentLine,
java.lang.String pRollbackSourceDevelopmentLineID)
Convenience method for adding a file for update to the destination This method does not validate the existence of the file in the source VFS. |
void |
addFileForUpdateByURI(java.lang.String pFileURI)
Convenience method for adding a file for update to the destination This method does not validate the existence of the file in the source VFS. |
void |
addFileForUpdateByURI(java.lang.String pFileURI,
java.lang.String pForwardSourceDevelopmentLine,
java.lang.String pRollbackSourceDevelopmentLineID)
Convenience method for adding a file for update to the destination This method does not validate the existence of the file in the source VFS. |
void |
addNewFile(VirtualFile pFile)
Convenience method for adding a new file to the deployment destination |
void |
addNewFile(VirtualFile pFile,
java.lang.String pForwardSourceDevelopmentLineID,
java.lang.String pRollbackSourceDevelopmentLineID)
Convenience method for adding a new file to the deployment destination |
void |
addNewFileByFileString(java.lang.String pFileString)
Convenience method for adding a new file to the deployment destination. |
void |
addNewFileByFileString(java.lang.String pFileString,
java.lang.String pForwardSourceDevelopmentLineID,
java.lang.String pRollbackSourceDevelopmentLineID)
Convenience method for adding a new file to the deployment destination. |
void |
addNewFileByPath(java.lang.String pFilePath)
Convenience method for adding a new file to the deployment destination. |
void |
addNewFileByPath(java.lang.String pFilePath,
java.lang.String pForwardSourceDevelopmentLine,
java.lang.String pRollbackSourceDevelopmentLineID)
Convenience method for adding a new file to the deployment destination. |
void |
addNewFileByURI(java.lang.String pFileURI)
Convenience method for adding a new file to the deployment destination. |
void |
addNewFileByURI(java.lang.String pFileURI,
java.lang.String pForwardSourceDevelopmentLine,
java.lang.String pRollbackSourceDevelopmentLineID)
Convenience method for adding a new file to the deployment destination. |
java.lang.Object |
clone()
Returns a clone of this object. |
void |
convertToRollbackData()
Converts a particular DeploymentData from a list of items modified in a deployment to a rollback for that deployment. |
FileDeploymentDestination |
getDestination()
|
java.lang.String |
getDestinationFileSystemPath()
|
int |
getMarkerCount()
Returns the number of markers for deployment |
java.util.Collection |
getNextSetOfMarkers(int pCurrentIndex,
int pBatchSize)
Returns some set of markers, starting at pCurrentIndex, of a number up to pBatchsize. |
RepositoryItem |
getRepositoryItem()
Returns the deployment data repository item |
VirtualFileSystem |
getSourceFileSystem()
|
java.lang.Integer |
operationForItemByPath(java.lang.String pFilePath)
Convenience method checking if an item is already in the DeploymentDatat |
java.lang.Integer[] |
operationForItemByURI(java.lang.String pFileURI)
Convenience method checking if an item is already in the DeploymentDatat |
void |
persist(MutableRepository pDeploymentRepository,
MutableRepositoryItem pDeploymentItem)
Writes the deploymentData item to the repository. |
void |
setDestination(FileDeploymentDestination pDestination)
|
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
public static final java.lang.String FILE_TYPE
public static final java.lang.String URI_PREFIX
public static final java.lang.String PATH_PREFIX
public java.util.LinkedHashMap mFileURIsToAddInput
public java.util.LinkedHashMap mFileURIsToUpdateInput
public java.util.LinkedHashMap mFileURIsToDeleteInput
public java.util.LinkedHashMap mFileURIsToAddRollbackInput
public java.util.LinkedHashMap mFileURIsToUpdateRollbackInput
public java.util.LinkedHashMap mFileURIsToDeleteRollbackInput
Constructor Detail |
---|
public FileDeploymentData(VirtualFileSystem pSourceFileSystem, FileDeploymentDestination pDestination)
public FileDeploymentData(VirtualFileSystem pSourceFileSystem, FileDeploymentDestination pDestination, java.lang.String pDestinationFileSystemPath)
Method Detail |
---|
public java.util.Collection getNextSetOfMarkers(int pCurrentIndex, int pBatchSize)
getNextSetOfMarkers
in interface DeploymentData
public VirtualFileSystem getSourceFileSystem()
public java.lang.String getDestinationFileSystemPath()
public FileDeploymentDestination getDestination()
public void setDestination(FileDeploymentDestination pDestination)
pDestination
- Sets the property value of the Destination property.public java.lang.Integer[] operationForItemByURI(java.lang.String pFileURI) throws RepositoryException
RepositoryException
public java.lang.Integer operationForItemByPath(java.lang.String pFilePath) throws RepositoryException
RepositoryException
public void addNewFileByURI(java.lang.String pFileURI)
java.lang.IllegalArgumentException
- if the file is already in the deployment or file
file does not exist in the source file systempublic void addNewFileByURI(java.lang.String pFileURI, java.lang.String pForwardSourceDevelopmentLine, java.lang.String pRollbackSourceDevelopmentLineID)
java.lang.IllegalArgumentException
- if the file is already in the deployment or file
file does not exist in the source file systempublic void addFileForUpdateByURI(java.lang.String pFileURI)
java.lang.IllegalArgumentException
- if the file is already in the deployment or file
file does not exist in the source file systempublic void addFileForUpdateByURI(java.lang.String pFileURI, java.lang.String pForwardSourceDevelopmentLine, java.lang.String pRollbackSourceDevelopmentLineID)
java.lang.IllegalArgumentException
- if the file is already in the deployment or file
file does not exist in the source file systempublic void addFileForDeleteByURI(java.lang.String pFileURI)
java.lang.IllegalArgumentException
- if the file is already in the deployment or file
file does not exist in the source file systempublic void addFileForDeleteByURI(java.lang.String pFileURI, java.lang.String pForwardSourceDevelopmentLine, java.lang.String pRollbackSourceDevelopmentLineID)
java.lang.IllegalArgumentException
- if the file is already in the deployment or file
file does not exist in the source file systempublic void addNewFileByPath(java.lang.String pFilePath)
java.lang.IllegalArgumentException
- if the file is already in the deployment or file
file does not exist in the source file systempublic void addNewFileByPath(java.lang.String pFilePath, java.lang.String pForwardSourceDevelopmentLine, java.lang.String pRollbackSourceDevelopmentLineID)
java.lang.IllegalArgumentException
- if the file is already in the deployment or file
file does not exist in the source file systempublic void addFileForUpdateByPath(java.lang.String pFilePath)
java.lang.IllegalArgumentException
- if the file is already in the deployment or file
file does not exist in the source file systempublic void addFileForUpdateByPath(java.lang.String pFilePath, java.lang.String pForwardSourceDevelopmentLine, java.lang.String pRollbackSourceDevelopmentLineID)
java.lang.IllegalArgumentException
- if the file is already in the deployment or file
file does not exist in the source file systempublic void addFileForDeleteByPath(java.lang.String pFilePath)
java.lang.IllegalArgumentException
- if the file is already in the deployment or file
file does not exist in the source file systempublic void addFileForDeleteByPath(java.lang.String pFilePath, java.lang.String pForwardSourceDevelopmentLine, java.lang.String pRollbackSourceDevelopmentLineID)
java.lang.IllegalArgumentException
- if the file is already in the deployment or file
file does not exist in the source file systempublic void addNewFileByFileString(java.lang.String pFileString)
java.lang.IllegalArgumentException
- if the file is already in the deployment or file
file does not exist in the source file systempublic void addNewFileByFileString(java.lang.String pFileString, java.lang.String pForwardSourceDevelopmentLineID, java.lang.String pRollbackSourceDevelopmentLineID)
java.lang.IllegalArgumentException
- if the file is already in the deployment or file
file does not exist in the source file systempublic void addFileForUpdateByFileString(java.lang.String pFileString)
java.lang.IllegalArgumentException
- if the file is already in the deployment or file
file does not exist in the source file systempublic void addFileForUpdateByFileString(java.lang.String pFileString, java.lang.String pForwardSourceDevelopmentLineID, java.lang.String pRollbackSourceDevelopmentLineID)
java.lang.IllegalArgumentException
- if the file is already in the deployment or file
file does not exist in the source file systempublic void addFileForDeleteByFileString(java.lang.String pFileString)
java.lang.IllegalArgumentException
- if the file is already in the deployment or file
file does not exist in the source file systempublic void addFileForDeleteByFileString(java.lang.String pFileString, java.lang.String pForwardSourceDevelopmentLineID, java.lang.String pRollbackSourceDevelopmentLineID)
java.lang.IllegalArgumentException
- if the file is already in the deployment or file
file does not exist in the source file systempublic void addNewFile(VirtualFile pFile)
java.lang.IllegalArgumentException
- if the file is already in the deployment or file
file does not exist in the source file systempublic void addNewFile(VirtualFile pFile, java.lang.String pForwardSourceDevelopmentLineID, java.lang.String pRollbackSourceDevelopmentLineID)
java.lang.IllegalArgumentException
- if the file is already in the deployment or file
file does not exist in the source file systempublic void addFileForUpdate(VirtualFile pFile)
java.lang.IllegalArgumentException
- if the file is already in the deployment or file
file does not exist in the source file systempublic void addFileForUpdate(VirtualFile pFile, java.lang.String pForwardSourceDevelopmentLineID, java.lang.String pRollbackSourceDevelopmentLineID)
java.lang.IllegalArgumentException
- if the file is already in the deployment or file
file does not exist in the source file systempublic void addFileForDelete(VirtualFile pFile)
java.lang.IllegalArgumentException
- if the file is already in the deployment or file
file does not exist in the source file systempublic void addFileForDelete(VirtualFile pFile, java.lang.String pForwardSourceDevelopmentLineID, java.lang.String pRollbackSourceDevelopmentLineID)
java.lang.IllegalArgumentException
- if the file is already in the deployment or file
file does not exist in the source file systempublic void persist(MutableRepository pDeploymentRepository, MutableRepositoryItem pDeploymentItem) throws atg.deployment.DistributedDeploymentException
persist
in interface DeploymentData
RepositoryException
- if an error occurs while persisting
atg.deployment.DistributedDeploymentException
public RepositoryItem getRepositoryItem()
getRepositoryItem
in interface DeploymentData
public int getMarkerCount()
getMarkerCount
in interface DeploymentData
public void convertToRollbackData()
add -> delete
update -> update
delete -> add
Note that this function is reversible - calling it twice is the same as not calling it.
convertToRollbackData
in interface DeploymentData
public java.lang.Object clone()
clone
in interface DeploymentData
clone
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |