org.ispheres.shared.core
Interface ISphereAdminInterface

All Known Implementing Classes:

ISphere, ISphereClient

public interface ISphereAdminInterface

An interface defining the Admin user functions.

Author:

Owen Jones, Clinton Freeman, Jonathan Mezach

Method Summary

LogFile	consistancyCheck() Checks the consistancy of the ISphere.
ProcessPublicInterface	registerCollectionWithAuthorityServer(int collectionId) Registers a collection within this iSphere with the central authority server.
ProcessPublicInterface	registerWithAuthorityServer() Registers this iSphere with the central authority server.
void	shutDownISphere() This function shutsdown the HTTP server (and ISphere).

Method Detail

consistancyCheck

LogFile consistancyCheck()
                         throws ISphereException

Checks the consistancy of the ISphere. A consistancy report is generated by this function.

Returns:

A LogFile detailing the results of the consistancy check.

Throws:

ISphereException - Thrown when unable to check consistancy of the the iSphere.

registerCollectionWithAuthorityServer

ProcessPublicInterface registerCollectionWithAuthorityServer(int collectionId)
                                                             throws ISphereException

Registers a collection within this iSphere with the central authority server.

Parameters:

collectionId - The unique identifier of the collection to register.

Returns:

A reference to the Process that will perform this action.

Throws:

ISphereException - If the specified collection does not exist.

See Also:

AuthorityServer

registerWithAuthorityServer

ProcessPublicInterface registerWithAuthorityServer()
                                                   throws ISphereException

Registers this iSphere with the central authority server.

Returns:

A reference to the Process that will perform this action.

Throws:

ISphereException - Thrown when unable to register iSphere with authority server.

See Also:

RegisterISphere

shutDownISphere

void shutDownISphere()
                     throws ISphereException

This function shutsdown the HTTP server (and ISphere).

Throws:

ISphereException - If unable to shutdown the iSphere.