|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IRestClient
The IRestClient
interface is the API for all REST clients used by the Eclipse ModeShape plugin.
Method Summary | |
---|---|
Collection<Repository> |
getRepositories(Server server)
Obtains the ModeShape repositories defined within the specified server. |
URL |
getUrl(File file,
String path,
Workspace workspace)
|
Collection<Workspace> |
getWorkspaces(Repository repository)
Obtains the workspaces defined within the specified ModeShape respository. |
Status |
publish(Workspace workspace,
String path,
File file)
Publishes, or uploads, a local file to the workspace at the specified path. |
Status |
unpublish(Workspace workspace,
String path,
File file)
Unpublishes, or deletes, the resource at the specified path in the workspace. |
Method Detail |
---|
Collection<Repository> getRepositories(Server server) throws Exception
server
- the server whose repositories are being requested (never null
)
null
)
Exception
- if there is a problem obtaining the repositoriesURL getUrl(File file, String path, Workspace workspace) throws Exception
file
- the file whose URL is being requested (never null
)path
- the path in the ModeShape workspace where the file is/could be located (never null
)workspace
- the workspace where the file is/could be located (never null
)
null
)
Exception
- if there is a problem obtaining the URL or if the file is a directoryCollection<Workspace> getWorkspaces(Repository repository) throws Exception
repository
- the repository whose workspaces are being requested (never null
)
null
)
Exception
- if there is a problem obtaining the workspacesStatus publish(Workspace workspace, String path, File file)
workspace
- the workspace where the resource will be published (never null
)path
- the unencoded path to the folder where the file will be published (never null
)file
- the resource being published (never null
)
null
)Status unpublish(Workspace workspace, String path, File file)
info status
is returned.
workspace
- the workspace where the resource will be unpublished (never null
)path
- the unencoded path to the folder where the file is published (never null
)file
- the file being unpublished (never null
)
null
)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |