net.bluemind.server.api

Interface IServer

All Known Implementing Classes:

ServerService

@Path(value="/servers/{containerUid}")
public interface IServer

API for managing the servers in a BlueMind installation. Server is the equivalent of Host in core_v1. Server are items living in an installation Container. The uid of the container is determined using the /etc/bm/mcast.id on your bluemind installation.

Method Summary

Modifier and Type	Method and Description
java.util.List<ItemValue<Server>>	allComplete() Enumerate all the servers in the installation container.
void	assign(java.lang.String serverUid, java.lang.String domainUid, java.lang.String tag) Assigns a Server's tag to a domain.
java.util.List<java.lang.String>	byAssignment(java.lang.String domainUid, java.lang.String tag) Fetches all the servers in a domain container by its assignment
TaskRef	create(java.lang.String uid, Server srv) Creates a new server in the database with the given uid.
void	delete(java.lang.String uid) Deletes a server object in the database with its uid.
java.util.List<Assignment>	getAssignments(java.lang.String domainUid) Fetches all the server assignments in a domain container
ItemValue<Server>	getComplete(java.lang.String uid) Fetches a server object from the database with its uid.
java.util.List<Assignment>	getServerAssignments(java.lang.String uid)
CommandStatus	getStatus(java.lang.String uid, java.lang.String commandRef) Fetches the progress of a command running in bm-node
byte[]	readFile(java.lang.String uid, java.lang.String path) Uses bm-node to read a file on a Server with its uid.
TaskRef	setTags(java.lang.String uid, java.util.List<java.lang.String> tags) tags server and return ref to Task (ITask
java.lang.String	submit(java.lang.String uid, java.lang.String command) Executes a command using bm-node on the server with the given uid.
CommandStatus	submitAndWait(java.lang.String uid, java.lang.String command) Executes a command using bm-node on the server with the given uid.
void	unassign(java.lang.String serverUid, java.lang.String domainUid, java.lang.String tag) Undo what assign does.
TaskRef	update(java.lang.String uid, Server srv) Updates a server in the database with its uid.
void	writeFile(java.lang.String uid, java.lang.String path, byte[] content) Uses bm-node to write a file on a Server with its uid.

Method Detail

create

@PUT
 @Path(value="{uid}")
TaskRef create(@PathParam(value="uid")
                                          java.lang.String uid,
                                          Server srv)
                                   throws ServerFault

Creates a new server in the database with the given uid. IServerHook implementations are invoked.

Parameters:

uid -

srv -

Throws:

ServerFault

update

@POST
 @Path(value="{uid}")
TaskRef update(@PathParam(value="uid")
                                           java.lang.String uid,
                                           Server srv)
                                    throws ServerFault

Updates a server in the database with its uid. IServerHook implementations are invoked.

Parameters:

uid -

srv -

Throws:

ServerFault

getComplete

@GET
 @Path(value="{uid}/complete")
ItemValue<Server> getComplete(@PathParam(value="uid")
                                                                  java.lang.String uid)
                                                           throws ServerFault

Fetches a server object from the database with its uid.

Parameters:

uid -

Returns:

Throws:

ServerFault

delete

@DELETE
 @Path(value="{uid}")
void delete(@PathParam(value="uid")
                                          java.lang.String uid)
                                   throws ServerFault

Deletes a server object in the database with its uid.

Parameters:

uid -

Throws:

ServerFault

allComplete

@GET
 @Path(value="_complete")
java.util.List<ItemValue<Server>> allComplete()
                                                                      throws ServerFault

Enumerate all the servers in the installation container.

Returns:

Throws:

ServerFault

submit

@POST
 @Path(value="{uid}/submit_command")
java.lang.String submit(@PathParam(value="uid")
                                                                   java.lang.String uid,
                                                                   java.lang.String command)
                                                            throws ServerFault

Executes a command using bm-node on the server with the given uid. Returns a reference to the running command that must be used in subsequent getStatus calls.

Parameters:

uid -

command -

Returns:

Throws:

ServerFault

submitAndWait

@POST
 @Path(value="{uid}/submit_command_and_wait")
CommandStatus submitAndWait(@PathParam(value="uid")
                                                                                java.lang.String uid,
                                                                                java.lang.String command)
                                                                         throws ServerFault

Executes a command using bm-node on the server with the given uid. Returns command execution output and exit code (CommandStatus).

Parameters:

uid -

command -

Returns:

Throws:

ServerFault

getStatus

@GET
 @Path(value="{uid}/command_status")
CommandStatus getStatus(@PathParam(value="uid")
                                                                  java.lang.String uid,
                                                                  @QueryParam(value="ref")
                                                                  java.lang.String commandRef)
                                                           throws ServerFault

Fetches the progress of a command running in bm-node

Parameters:

uid -

commandRef -

Returns:

Throws:

ServerFault

readFile

@GET
 @Path(value="{uid}/fs/{path}")
byte[] readFile(@PathParam(value="uid")
                                                     java.lang.String uid,
                                                     @PathParam(value="path")
                                                     java.lang.String path)
                                              throws ServerFault

Uses bm-node to read a file on a Server with its uid.

Parameters:

uid - the server uid

path - the absolute filename to read

Returns:

the bytes in the file

Throws:

ServerFault

writeFile

@PUT
 @Path(value="{uid}/fs/{path}")
void writeFile(@PathParam(value="uid")
                                                    java.lang.String uid,
                                                    @PathParam(value="path")
                                                    java.lang.String path,
                                                    byte[] content)
                                             throws ServerFault

Uses bm-node to write a file on a Server with its uid.

Parameters:

uid - the server uid

path - the absolute filename to write

content -

Throws:

ServerFault

assign

@POST
 @Path(value="{domainUid}/assignments/{serverUid}/_assign")
void assign(@PathParam(value="serverUid")
                                                                              java.lang.String serverUid,
                                                                              @PathParam(value="domainUid")
                                                                              java.lang.String domainUid,
                                                                              @QueryParam(value="tag")
                                                                              java.lang.String tag)
                                                                       throws ServerFault

Assigns a Server's tag to a domain. For example, when you assign your mail/imap Server to a domain blue-mind.net a mail partition will be created to hold this domain data. This method stores the newly made assignment in the database and IServerHook implementations will do all the system work.

Parameters:

serverUid -

domainUid -

tag -

Throws:

ServerFault

unassign

@POST
 @Path(value="{domainUid}/assignments/{serverUid}/_unassign")
void unassign(@PathParam(value="serverUid")
                                                                                  java.lang.String serverUid,
                                                                                  @PathParam(value="domainUid")
                                                                                  java.lang.String domainUid,
                                                                                  @QueryParam(value="tag")
                                                                                  java.lang.String tag)
                                                                           throws ServerFault

Undo what assign does.

Parameters:

serverUid -

domainUid -

tag -

Throws:

ServerFault

getAssignments

@GET
 @Path(value="{domainUid}/assignments")
java.util.List<Assignment> getAssignments(@PathParam(value="domainUid")
                                                                                       java.lang.String domainUid)
                                                                                throws ServerFault

Fetches all the server assignments in a domain container

Parameters:

domainUid -

Returns:

Throws:

ServerFault

byAssignment

@GET
 @Path(value="{domainUid}/byAssignment")
java.util.List<java.lang.String> byAssignment(@PathParam(value="domainUid")
                                                                                            java.lang.String domainUid,
                                                                                            @QueryParam(value="tag")
                                                                                            java.lang.String tag)
                                                                                     throws ServerFault

Fetches all the servers in a domain container by its assignment

Parameters:

domainUid -

assignment -

Returns:

Throws:

ServerFault

setTags

@POST
 @Path(value="{uid}/tags")
TaskRef setTags(@PathParam(value="uid")
                                                 java.lang.String uid,
                                                 java.util.List<java.lang.String> tags)
                                          throws ServerFault

tags server and return ref to Task (ITask

Parameters:

uid -

tags -

Returns:

Throws:

ServerFault

getServerAssignments

@GET
 @Path(value="{uid}/serverAssignments")
java.util.List<Assignment> getServerAssignments(@PathParam(value="uid")
                                                                                             java.lang.String uid)
                                                                                      throws ServerFault

Throws:

ServerFault