com.marklogic.client.admin

Interface NamespacesManager

public interface NamespacesManager

The NamespacesManager provides access and editing for the namespaces defined on the server. To use NamespacesManager, an application must authenticate as rest-admin.

Method Summary

Modifier and Type	Method and Description
void	addPrefix(String prefix, String namespaceURI) Creates a namespace binding on the server.
void	deleteAll() Deletes all namespace bindings on the server.
void	deletePrefix(String prefix) Deletes a namespace binding on the server.
NamespaceContext	readAll() Reads all of the namespace bindings from the server.
String	readPrefix(String prefix) Returns the namespace URI bound to the specified prefix on the server.
void	startLogging(RequestLogger logger) Starts debugging client requests.
void	stopLogging() Stops debugging client requests.
void	updatePrefix(String prefix, String namespaceURI) Writes a namespace binding on the server.

Method Detail

readPrefix

String readPrefix(String prefix)
           throws ForbiddenUserException,
                  FailedRequestException

Returns the namespace URI bound to the specified prefix on the server.

Parameters:

prefix - the prefix for the binding

Returns:

the namespace URI

Throws:

ForbiddenUserException

FailedRequestException

readAll

NamespaceContext readAll()
                  throws ForbiddenUserException,
                         FailedRequestException

Reads all of the namespace bindings from the server.

Returns:

a namespace context with the bindings

Throws:

ForbiddenUserException

FailedRequestException

addPrefix

void addPrefix(String prefix,
               String namespaceURI)
        throws ForbiddenUserException,
               FailedRequestException

Creates a namespace binding on the server.

Parameters:

prefix - the prefix bound to the URI

namespaceURI - the URI bound to the prefix

Throws:

ForbiddenUserException

FailedRequestException

updatePrefix

void updatePrefix(String prefix,
                  String namespaceURI)
           throws ResourceNotFoundException,
                  ForbiddenUserException,
                  FailedRequestException

Writes a namespace binding on the server.

Parameters:

prefix - the prefix bound to the URI

namespaceURI - the URI bound to the prefix

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

deletePrefix

void deletePrefix(String prefix)
           throws ResourceNotFoundException,
                  ForbiddenUserException,
                  FailedRequestException

Deletes a namespace binding on the server.

Parameters:

prefix - the prefix bound to the URI

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

deleteAll

void deleteAll()
        throws ForbiddenUserException,
               FailedRequestException

Deletes all namespace bindings on the server.

Throws:

ForbiddenUserException

FailedRequestException

startLogging

void startLogging(RequestLogger logger)

Starts debugging client requests. You can suspend and resume debugging output using the methods of the logger.

Parameters:

logger - the logger that receives debugging output

stopLogging

void stopLogging()

Stops debugging client requests.