org.mmbase.bridge
Interface CloudContext

All Known Implementing Classes:

org.mmbase.bridge.implementation.BasicCloudContext

public interface CloudContext

The collection of clouds and modules within a Java Virtual Machine.

Version:

$Id: CloudContext.java,v 1.20 2003/11/10 16:47:14 michiel Exp $

Author:

Rob Vermeulen, Pierre van Rooden, Jaco de Groot

Method Summary

FieldList	createFieldList() Returns a new, empty field list
ModuleList	createModuleList() Returns a new, empty module list
NodeList	createNodeList() Returns a new, empty node list
NodeManagerList	createNodeManagerList() Returns a new, empty node manager list
RelationList	createRelationList() Returns a new, empty relation list
RelationManagerList	createRelationManagerList() Returns a new, empty relation manager list
StringList	createStringList() Returns a new, empty string list
Cloud	getCloud(java.lang.String name) Returns the cloud with the specified name.
Cloud	getCloud(java.lang.String name, java.lang.String authenticationType, java.util.Map loginInfo) Returns the cloud with the specified name, with authentication
StringList	getCloudNames() Returns the names of all the clouds known to the system
java.lang.String	getDefaultCharacterEncoding() Returns the default character encoding, which can be used as a default.
java.util.Locale	getDefaultLocale() Returns the default locale setting.
Module	getModule(java.lang.String name) Returns the module with the specified name.
ModuleList	getModules() Returns all modules available in this context.
boolean	hasModule(java.lang.String name) Returns whether the module with the specified name is available.

Method Detail

getModules

public ModuleList getModules()

Returns all modules available in this context.

Returns:

all available modules

getModule

public Module getModule(java.lang.String name)
                 throws NotFoundException

Returns the module with the specified name.

Parameters:

name - the name of the module to be returned

Returns:

the requested module

Throws:

NotFoundException - if the specified module could not be found

hasModule

public boolean hasModule(java.lang.String name)

Returns whether the module with the specified name is available.

Parameters:

name - the name of the module

Returns:

true if the module is available

getCloud

public Cloud getCloud(java.lang.String name)

Returns the cloud with the specified name.

Parameters:

name - the name of the cloud to be returned

Returns:

the requested cloud

Throws:

CloudNotFoundException - if the specified cloud could not be found

java.lang.SecurityException - if no anonymous user can be created

getCloud

public Cloud getCloud(java.lang.String name,
                      java.lang.String authenticationType,
                      java.util.Map loginInfo)
               throws NotFoundException

Returns the cloud with the specified name, with authentication

Parameters:

name - the name of the cloud to be returned

authenticationType - the type of authentication, which should be used by the authentication implementation.

loginInfo - the user related login information.

Returns:

the requested cloud

Throws:

NotFoundException - if the specified cloud could not be found

getCloudNames

public StringList getCloudNames()

Returns the names of all the clouds known to the system

Returns:

A StringList of all clouds names known to our Context

getDefaultCharacterEncoding

public java.lang.String getDefaultCharacterEncoding()

Returns the default character encoding, which can be used as a default.

Returns:

A string with the character encoding

Since:

MMBase-1.6

getDefaultLocale

public java.util.Locale getDefaultLocale()

Returns the default locale setting.

Returns:

A Locale object

Since:

MMBase-1.6

createFieldList

public FieldList createFieldList()

Returns a new, empty field list

Returns:

The empty list

Since:

MMBase-1.6

createNodeList

public NodeList createNodeList()

Returns a new, empty node list

Returns:

The empty list

Since:

MMBase-1.6

createRelationList

public RelationList createRelationList()

Returns a new, empty relation list

Returns:

The empty list

Since:

MMBase-1.6

createNodeManagerList

public NodeManagerList createNodeManagerList()

Returns a new, empty node manager list

Returns:

The empty list

Since:

MMBase-1.6

createRelationManagerList

public RelationManagerList createRelationManagerList()

Returns a new, empty relation manager list

Returns:

The empty list

Since:

MMBase-1.6

createModuleList

public ModuleList createModuleList()

Returns a new, empty module list

Returns:

The empty list

Since:

MMBase-1.6

createStringList

public StringList createStringList()

Returns a new, empty string list

Returns:

The empty list

Since:

MMBase-1.6