|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.wso2.carbon.registry.synchronization.operation.CheckOutCommand
public class CheckOutCommand
This command is used to perform a check-out operation which will download the resources and collections from the provided registry instance into the local filesystem.
Constructor Summary | |
---|---|
CheckOutCommand(String outputFile,
String workingDir,
String userUrl,
String username,
boolean cleanRegistry)
Creates an instance of a check-out command which can be executed against a provided registry instance. |
Method Summary | |
---|---|
boolean |
execute(Registry registry)
This method will execute the check-out command utilizing the various parameters passed when creating the instance of the command. |
boolean |
execute(Registry registry,
UserInputCallback callback)
This method will execute the check-out command utilizing the various parameters passed when creating the instance of the command. |
int |
getAddedCount()
Method to obtain the count of files added. |
int |
getNonOverwrittenCount()
Method to obtain the count of files that were not overwritten. |
int |
getOverwrittenCount()
Method to obtain the count of files overwritten. |
void |
setDumpLite(boolean dumpLite)
Method to specify weather to use dump or dump lite |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public CheckOutCommand(String outputFile, String workingDir, String userUrl, String username, boolean cleanRegistry) throws SynchronizationException
outputFile
- if the content is to be downloaded into a single meta file, this
parameter can be used to specify the path to the meta file.workingDir
- if the content is to be downloaded into a directory on the filesystem,
this parameter can be used to specify the path to the corresponding
location.userUrl
- aggregate URL containing a concatenation of the registry URL and the
resource path that is capable of referencing a remote resource. This url
will contain only the resource path if the resource was local to the
given registry instance.username
- the name of the user (which should be a valid username on the target
server on which the provided registry instance is running) that performs
this operation.cleanRegistry
- whether the embedded registry instance must be cleaned after the
execution of the operation.
SynchronizationException
- if the operation failed.Method Detail |
---|
public int getAddedCount()
public int getOverwrittenCount()
public int getNonOverwrittenCount()
public void setDumpLite(boolean dumpLite)
dumpLite
- public boolean execute(Registry registry, UserInputCallback callback) throws SynchronizationException
registry
- the registry instance to be used.callback
- the instance of a callback that can be used to determine the user's
preference before overwriting an existing file or directory during operation.
If this parameter is null, the default behaviour of overwriting the existing
file will be used.
SynchronizationException
- if the operation failed.public boolean execute(Registry registry) throws SynchronizationException
registry
- the registry instance to be used.
SynchronizationException
- if the operation failed.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |