org.rhq.enterprise.server.plugin.pc.content
Interface ContentProvider

public interface ContentProvider

Interface used by the server to communicate with a content provider. Content providers implement this interface as well as any other source interfaces to further describe what functionality is provided by the provider.

The class name of this interface's implementation is the class name specified in the server plugin descriptor.

Author:

Jason Dobies, John Mazzitelli

See Also:

RepoSource, PackageSource

Method Summary

void	initialize(Configuration configuration) Initializes the adapter with the configuration values indicating how to connect to the external source system.
void	shutdown() Informs the adapter that it should shutdown.
void	testConnection() Tests if the content provider can communicate with the external package source.

Method Detail

initialize

void initialize(Configuration configuration)
                throws java.lang.Exception

Initializes the adapter with the configuration values indicating how to connect to the external source system.

Parameters:

configuration - user entered values describing how the content provider should function.

Throws:

java.lang.Exception - if the content provider has an issue being configured.

shutdown

void shutdown()

Informs the adapter that it should shutdown.

testConnection

void testConnection()
                    throws java.lang.Exception

Tests if the content provider can communicate with the external package source. This will be called after initialize(Configuration) to ensure the adapter is in a configured state to run the test.

Throws:

java.lang.Exception - if the connection cannot be made to the external system.