ClearspaceManager (Openfire 3.9.3 Javadoc)

Overview

Package

Class

Tree

Deprecated

Index

Help

Openfire 3.9.3 Javadoc

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jivesoftware.openfire.clearspace
Class ClearspaceManager

java.lang.Object
  org.jivesoftware.openfire.container.BasicModule
      org.jivesoftware.openfire.clearspace.ClearspaceManager

All Implemented Interfaces:: ComponentEventListener, ExternalComponentManagerListener, Module, CertificateEventListener, PropertyEventListener

public class ClearspaceManager
extends BasicModule
implements ExternalComponentManagerListener, ComponentEventListener, PropertyEventListener, CertificateEventListener
extends BasicModule
implements ExternalComponentManagerListener, ComponentEventListener, PropertyEventListener, CertificateEventListener

Centralized administration of Clearspace connections. The getInstance() method should be used to get an instance. The following properties configure this manager:

clearspace.uri
clearspace.sharedSecret

Author:: Daniel Henninger

Nested Class Summary
`static class`	`ClearspaceManager.HttpType` Different kind of HTTP request types

Field Summary
`protected static String`	`CHAT_URL_PREFIX`
`static String`	`CLEARSPACE_COMPONENT`
`protected static String`	`IM_URL_PREFIX`
`static String`	`MUC_SUBDOMAIN`

Constructor Summary
`ClearspaceManager()` Constructs a new ClearspaceManager instance.
`ClearspaceManager(Map<String,String> properties)` Constructs a new ClearspaceManager instance.

Method Summary
`void`	`certificateCreated(KeyStore keyStore, String alias, X509Certificate cert)` Event triggered when a new certificate is created.
`void`	`certificateDeleted(KeyStore keyStore, String alias)` Event triggered when a certificate is being deleted from the keystore.
`void`	`certificateSigned(KeyStore keyStore, String alias, List<X509Certificate> certificates)` Event triggered when a certificate has been signed by a Certificate Authority.
`Boolean`	`checkAuthentication(String username, String password)` Check a username/password pair for valid authentication.
`void`	`componentAllowed(String subdomain, ExternalComponentConfiguration configuration)` Notification indicating that a new component was allowed to connect using a given configuration.
`void`	`componentBlocked(String subdomain)` Notification indicating that a component was blocked to connect to the server.
`void`	`componentConfigurationDeleted(String subdomain)` Notification indicating that the configuration of a component, that was either blocked or allowed to connect, is being deleted.
`void`	`componentInfoReceived(org.xmpp.packet.IQ iq)` The server has received a disco#info response from the component.
`void`	`componentRegistered(org.xmpp.packet.JID componentJID)` A component was registered with the Component Manager.
`void`	`componentSecretUpdated(String subdomain, String newSecret)` Notification indicating that the configuration of a component, that was either blocked or allowed to connect, is being deleted.
`void`	`componentUnregistered(org.xmpp.packet.JID componentJID)` A component was removed.
`boolean`	`configClearspace()`
`void`	`defaultSecretChanged(String newSecret)` Notification indicating that the default secret is being modified.
`org.dom4j.Element`	`executeRequest(ClearspaceManager.HttpType type, String urlSuffix)` Makes a rest request of either type GET or DELETE at the specified urlSuffix.
`org.dom4j.Element`	`executeRequest(ClearspaceManager.HttpType type, String urlSuffix, String xmlParams)` Makes a rest request of any type at the specified urlSuffix.
`String`	`generateNonce()` Generates a new nonce.
`String`	`getConnectionURI()` Returns the Clearspace service URI; e.g.
`protected long`	`getGroupID(String groupname)` Returns the Clearspace group id of the group.
`static ClearspaceManager`	`getInstance()` Provides singleton access to an instance of the ClearspaceManager class.
`String`	`getNonce()` Returns a nonce generated by Clearspace to be used in a SSO login.
`Map<String,String>`	`getProperties()`
`String`	`getSharedSecret()` Returns the password, configured in Clearspace, that Openfire will use to authenticate with Clearspace to perform it's integration.
`protected long`	`getUserID(org.xmpp.packet.JID user)` Returns the Clearspace user id the user by JID.
`protected long`	`getUserID(String username)` Returns the Clearspace user id the user by username.
`protected String`	`getUsernameByID(Long id)` Returns the Clearspace username of the user by id.
`boolean`	`isClearspaceConfigured()` Returns true if Clerspace was configured at least one time since Openfire startup.
`Boolean`	`isClearspaceConnected()` Returns true if Clearspce is connected to Openfire.
`static boolean`	`isEnabled()` Returns true if Clearspace is being used as the backend of Openfire.
`boolean`	`isFromClearspace(org.xmpp.packet.JID address)` Returns true if a given JID belongs to a known Clearspace component domain.
`Boolean`	`isOpenfireConnected()` Returns true if Openfire is connected to Clearspace.
`boolean`	`isValidNonce(String nonce)` Returns true if the nonce was generated usig `generateNonce` and if this is the first check for that nonce.
`void`	`permissionPolicyChanged(ExternalComponentManager.PermissionPolicy newPolicy)` Notification indicating that the permission policy is being modified.
`void`	`portChanged(int newPort)` Notification indicating that the port used by external components is being modified.
`void`	`propertyDeleted(String property, Map params)` A property was deleted.
`void`	`propertySet(String property, Map params)` A property was set.
`org.xmpp.packet.IQ`	`query(org.xmpp.packet.IQ packet, int timeout)` Sends an IQ packet to the Clearspace external component and returns the IQ packet returned by CS or `null` if no answer was received before the specified timeout.
`void`	`serviceEnabled(boolean enabled)` Notification indicating whether the service is being enabled or disabled.
`void`	`setConnectionURI(String uri)` Sets the URI of the Clearspace service; e.g., `https://localhost:80/clearspace`.
`void`	`setSharedSecret(String sharedSecret)` Sets the shared secret for the Clearspace service we're connecting to.
`void`	`start()` Starts the basic module.
`void`	`stop()` Stops the basic module.
`Throwable`	`testConnection()` Tests the web services connection with Clearspace given the manager's current configuration.
`void`	`xmlPropertyDeleted(String property, Map params)` An XML property was deleted.
`void`	`xmlPropertySet(String property, Map params)` An XML property was set.

Methods inherited from class org.jivesoftware.openfire.container.BasicModule
`destroy, getName, initialize`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

IM_URL_PREFIX

protected static final String IM_URL_PREFIX

See Also:: Constant Field Values

CHAT_URL_PREFIX

protected static final String CHAT_URL_PREFIX

See Also:: Constant Field Values

MUC_SUBDOMAIN

public static final String MUC_SUBDOMAIN

See Also:: Constant Field Values

CLEARSPACE_COMPONENT

public static final String CLEARSPACE_COMPONENT

See Also:: Constant Field Values

Constructor Detail

ClearspaceManager

public ClearspaceManager(Map<String,String> properties)

Constructs a new ClearspaceManager instance. Typically, getInstance() should be called instead of this method. ClearspaceManager instances should only be created directly for testing purposes.

Parameters:: properties - the Map that contains properties used by the Clearspace manager, such as Clearspace host and shared secret.

ClearspaceManager

public ClearspaceManager()

Constructs a new ClearspaceManager instance. Typically, getInstance() should be called instead of this method. ClearspaceManager instances should only be created directly for testing purposes.

Method Detail

getInstance

public static ClearspaceManager getInstance()

Provides singleton access to an instance of the ClearspaceManager class.

Returns:: an ClearspaceManager instance.

checkAuthentication

public Boolean checkAuthentication(String username,
                                   String password)

Check a username/password pair for valid authentication.

Parameters:: username - Username to authenticate against.; password - Password to use for authentication.
Returns:: True or false of the authentication succeeded.

testConnection

public Throwable testConnection()

Tests the web services connection with Clearspace given the manager's current configuration.

Returns:: The exception or null if connection test was successful.

isOpenfireConnected

public Boolean isOpenfireConnected()

Returns true if Openfire is connected to Clearspace. This method may delay some time since it has to ping Clearspace to know if Openfire is able to connect to it.

Returns:: true if Openfire is connected to Clearspace.

isClearspaceConnected

public Boolean isClearspaceConnected()

Returns true if Clearspce is connected to Openfire.

Returns:: true if Clearspce is connected to Openfire.

getProperties

public Map<String,String> getProperties()

getConnectionURI

public String getConnectionURI()

Returns the Clearspace service URI; e.g. https://localhost:80/clearspace. This value is stored as the Jive Property clearspace.uri.

Returns:: the Clearspace service URI.

setConnectionURI

public void setConnectionURI(String uri)

Sets the URI of the Clearspace service; e.g., https://localhost:80/clearspace. This value is stored as the Jive Property clearspace.uri.

Parameters:: uri - the Clearspace service URI.

getSharedSecret

public String getSharedSecret()

Returns the password, configured in Clearspace, that Openfire will use to authenticate with Clearspace to perform it's integration.

Returns:: the password Openfire will use to authenticate with Clearspace.

setSharedSecret

public void setSharedSecret(String sharedSecret)

Sets the shared secret for the Clearspace service we're connecting to.

Parameters:: sharedSecret - the password configured in Clearspace to authenticate Openfire.

isEnabled

public static boolean isEnabled()

Returns true if Clearspace is being used as the backend of Openfire. When integrated with Clearspace then users and groups will be pulled out from Clearspace. User authentication will also rely on Clearspace.

Returns:: true if Clearspace is being used as the backend of Openfire.

start

public void start()
           throws IllegalStateException

Description copied from class: BasicModule

Starts the basic module.

Inheriting classes that choose to override this method MUST call this start() method before accessing BasicModule resources.

Specified by:: start in interface Module
Overrides:: start in class BasicModule

Throws:: IllegalStateException - If start is called before initialize successfully returns

stop

public void stop()

Description copied from class: BasicModule

Stops the basic module.

Inheriting classes that choose to override this method MUST call this stop() method before accessing BasicModule resources.

Specified by:: stop in interface Module
Overrides:: stop in class BasicModule

configClearspace

public boolean configClearspace()

isClearspaceConfigured

public boolean isClearspaceConfigured()

Returns true if Clerspace was configured at least one time since Openfire startup.

Returns:: true if Clerspace was configured at least one time since Openfire startup.