org.modeshape.web.server

Interface Connector

All Superinterfaces:

Serializable

All Known Implementing Classes:

ConnectorImpl, JsonConfigConnectorImpl

public interface Connector
extends Serializable

Author:

kulikov

Method Summary

Modifier and Type	Method and Description
LRepository	find(String name) Searches repository with given name.
Collection<RepositoryName>	getRepositories() Gets list of all available repositories.
void	login(String username, String password) Logs in with given credentials.
void	logout() Logs out.
Collection<RepositoryName>	search(String name)
void	start(javax.servlet.ServletContext context) Starts this connector using given context.
String	userName() Gets name of user currently logged in.

Method Detail

start

void start(javax.servlet.ServletContext context)
    throws RemoteException

Starts this connector using given context.

Parameters:

context - the context

Throws:

RemoteException - if there is an error with the connector

login

void login(String username,
           String password)
    throws RemoteException

Logs in with given credentials.

Parameters:

username - the user name

password - user's password.

Throws:

RemoteException

logout

void logout()

Logs out.

userName

String userName()

Gets name of user currently logged in.

Returns:

user name or null if not logged yet.

getRepositories

Collection<RepositoryName> getRepositories()

Gets list of all available repositories.

Returns:

the collection of repository names

find

LRepository find(String name)
          throws RemoteException

Searches repository with given name.

Parameters:

name - the name of the repository to search.

Returns:

repository instance or null if not found.

Throws:

RemoteException - if there is an error getting the repository

search

Collection<RepositoryName> search(String name)
                           throws RemoteException

Throws:

RemoteException