org.ogf.saga.sd

Class SDFactory

java.lang.Object

org.ogf.saga.sd.SDFactory

public abstract class SDFactory
extends Object

Factory for the creation of Discoverer objects. It is expected that an implementation will have a method for obtaining a default value for the URL of the information system.

Constructor Summary

Constructors

Constructor and Description
SDFactory()

Method Summary

Methods

Modifier and Type	Method and Description
static Discoverer	createDiscoverer() Creates a Discoverer with the default Session and URL.
static Discoverer	createDiscoverer(Session session) Creates a Discoverer with a specified session and a default and URL.
static Discoverer	createDiscoverer(Session session, URL url) Creates a Discoverer.
static Discoverer	createDiscoverer(String sagaFactoryClassname) Creates a Discoverer with the default Session and URL.
static Discoverer	createDiscoverer(String sagaFactoryClassname, Session session) Creates a Discoverer with a specified session and a default and URL.
static Discoverer	createDiscoverer(String sagaFactoryClassname, Session session, URL url) Creates a Discoverer.
protected abstract Discoverer	doCreateDiscoverer(Session session) Creates a Discoverer with the default URL.
protected abstract Discoverer	doCreateDiscoverer(Session session, URL url) Creates a Discoverer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SDFactory

public SDFactory()

Method Detail

doCreateDiscoverer

protected abstract Discoverer doCreateDiscoverer(Session session)
                                          throws AuthenticationFailedException,
                                                 AuthorizationFailedException,
                                                 DoesNotExistException,
                                                 IncorrectURLException,
                                                 NoSuccessException,
                                                 NotImplementedException,
                                                 TimeoutException

Creates a Discoverer with the default URL. To be provided by the implementation.

Parameters:

session - the session handle

Returns:

the discoverer

Throws:

AuthenticationFailedException - if none of the available session contexts could successfully be used for authentication

AuthorizationFailedException - if none of the available contexts of the used session could be used for successful authorization. That error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

DoesNotExistException - if the url is syntactically valid, but no service can be contacted at that URL

IncorrectURLException - if an implementation cannot handle the specified protocol, or that access to the specified entity via the given protocol is impossible

NoSuccessException - if no result can be returned because of information system or other internal problems

NotImplementedException - if not implemented by that SAGA implementation at all

TimeoutException - if a remote operation did not complete successfully because the network communication or the remote service timed out

doCreateDiscoverer

protected abstract Discoverer doCreateDiscoverer(Session session,
                            URL url)
                                          throws AuthenticationFailedException,
                                                 AuthorizationFailedException,
                                                 DoesNotExistException,
                                                 IncorrectURLException,
                                                 NoSuccessException,
                                                 NotImplementedException,
                                                 TimeoutException

Creates a Discoverer. To be provided by the implementation.

Parameters:

session - the session handle

url - the URL to guide the implementation

Returns:

the discoverer

Throws:

AuthenticationFailedException - if none of the available session contexts could successfully be used for authentication

AuthorizationFailedException - if none of the available contexts of the used session could be used for successful authorization. That error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

DoesNotExistException - if the url is syntactically valid, but no service can be contacted at that URL

IncorrectURLException - if an implementation cannot handle the specified protocol, or that access to the specified entity via the given protocol is impossible

NoSuccessException - if no result can be returned because of information system or other internal problems

NotImplementedException - if not implemented by that SAGA implementation at all

TimeoutException - if a remote operation did not complete successfully because the network communication or the remote service timed out

createDiscoverer

public static Discoverer createDiscoverer()
                                   throws AuthenticationFailedException,
                                          AuthorizationFailedException,
                                          DoesNotExistException,
                                          IncorrectURLException,
                                          NoSuccessException,
                                          NotImplementedException,
                                          TimeoutException

Creates a Discoverer with the default Session and URL.

Returns:

the discoverer instance

Throws:

AuthenticationFailedException - if none of the available session contexts could successfully be used for authentication

AuthorizationFailedException - if none of the available contexts of the used session could be used for successful authorization. That error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

DoesNotExistException - if the url is syntactically valid, but no service can be contacted at that URL

IncorrectURLException - if an implementation cannot handle the specified protocol, or that access to the specified entity via the given protocol is impossible

NoSuccessException - if no result can be returned because of information system or other internal problems

NotImplementedException - if not implemented by that SAGA implementation at all

TimeoutException - if a remote operation did not complete successfully because the network communication or the remote service timed out

createDiscoverer

public static Discoverer createDiscoverer(String sagaFactoryClassname)
                                   throws AuthenticationFailedException,
                                          AuthorizationFailedException,
                                          DoesNotExistException,
                                          IncorrectURLException,
                                          NoSuccessException,
                                          NotImplementedException,
                                          TimeoutException

Creates a Discoverer with the default Session and URL.

Parameters:

sagaFactoryClassname - the class name of the Saga factory to be used.

Returns:

the discoverer instance

Throws:

AuthenticationFailedException - if none of the available session contexts could successfully be used for authentication

AuthorizationFailedException - if none of the available contexts of the used session could be used for successful authorization. That error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

DoesNotExistException - if the url is syntactically valid, but no service can be contacted at that URL

IncorrectURLException - if an implementation cannot handle the specified protocol, or that access to the specified entity via the given protocol is impossible

NoSuccessException - if no result can be returned because of information system or other internal problems

NotImplementedException - if not implemented by that SAGA implementation at all

TimeoutException - if a remote operation did not complete successfully because the network communication or the remote service timed out

createDiscoverer

public static Discoverer createDiscoverer(Session session)
                                   throws AuthenticationFailedException,
                                          AuthorizationFailedException,
                                          DoesNotExistException,
                                          IncorrectURLException,
                                          NoSuccessException,
                                          NotImplementedException,
                                          TimeoutException

Creates a Discoverer with a specified session and a default and URL.

Parameters:

session - the session, or null

Returns:

the discoverer instance

Throws:

AuthenticationFailedException - if none of the available session contexts could successfully be used for authentication

AuthorizationFailedException - if none of the available contexts of the used session could be used for successful authorization. That error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

DoesNotExistException - if the url is syntactically valid, but no service can be contacted at that URL

IncorrectURLException - if an implementation cannot handle the specified protocol, or that access to the specified entity via the given protocol is impossible

NoSuccessException - if no result can be returned because of information system or other internal problems

NotImplementedException - if not implemented by that SAGA implementation at all

TimeoutException - if a remote operation did not complete successfully because the network communication or the remote service timed out

createDiscoverer

public static Discoverer createDiscoverer(String sagaFactoryClassname,
                          Session session)
                                   throws AuthenticationFailedException,
                                          AuthorizationFailedException,
                                          DoesNotExistException,
                                          IncorrectURLException,
                                          NoSuccessException,
                                          NotImplementedException,
                                          TimeoutException

Creates a Discoverer with a specified session and a default and URL.

Parameters:

sagaFactoryClassname - the class name of the Saga factory to be used.

session - the session handle, may be null

Returns:

the discoverer instance

Throws:

AuthenticationFailedException - if none of the available session contexts could successfully be used for authentication

AuthorizationFailedException - if none of the available contexts of the used session could be used for successful authorization. That error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

DoesNotExistException - if the url is syntactically valid, but no service can be contacted at that URL

IncorrectURLException - if an implementation cannot handle the specified protocol, or that access to the specified entity via the given protocol is impossible

NoSuccessException - if no result can be returned because of information system or other internal problems

NotImplementedException - if not implemented by that SAGA implementation at all

TimeoutException - if a remote operation did not complete successfully because the network communication or the remote service timed out

createDiscoverer

public static Discoverer createDiscoverer(Session session,
                          URL url)
                                   throws AuthenticationFailedException,
                                          AuthorizationFailedException,
                                          DoesNotExistException,
                                          IncorrectURLException,
                                          NotImplementedException,
                                          NoSuccessException,
                                          TimeoutException

Creates a Discoverer. The url specified as an input parameter is to assist the implementation to locate the underlying information system such that it can be queried.

Parameters:

session - the session handle, may be null

url - the URL to guide the implementation, may be null

Returns:

the discoverer instance

Throws:

AuthenticationFailedException - if none of the available session contexts could successfully be used for authentication

AuthorizationFailedException - if none of the available contexts of the used session could be used for successful authorization. That error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

DoesNotExistException - if the url is syntactically valid, but no service can be contacted at that URL

IncorrectURLException - if an implementation cannot handle the specified protocol, or that access to the specified entity via the given protocol is impossible

NoSuccessException - if no result can be returned because of information system or other internal problems

NotImplementedException - if not implemented by that SAGA implementation at all

TimeoutException - if a remote operation did not complete successfully because the network communication or the remote service timed out

createDiscoverer

public static Discoverer createDiscoverer(String sagaFactoryClassname,
                          Session session,
                          URL url)
                                   throws AuthenticationFailedException,
                                          AuthorizationFailedException,
                                          DoesNotExistException,
                                          IncorrectURLException,
                                          NotImplementedException,
                                          NoSuccessException,
                                          TimeoutException

Creates a Discoverer. The url specified as an input parameter is to assist the implementation to locate the underlying information system such that it can be queried.

Parameters:

sagaFactoryClassname - the class name of the Saga factory to be used.

session - the session handle, may be null

url - the URL to guide the implementation, may be null

Returns:

the discoverer instance

Throws:

AuthenticationFailedException - if none of the available session contexts could successfully be used for authentication

AuthorizationFailedException - if none of the available contexts of the used session could be used for successful authorization. That error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

DoesNotExistException - if the url is syntactically valid, but no service can be contacted at that URL

IncorrectURLException - if an implementation cannot handle the specified protocol, or that access to the specified entity via the given protocol is impossible

NoSuccessException - if no result can be returned because of information system or other internal problems

NotImplementedException - if not implemented by that SAGA implementation at all

TimeoutException - if a remote operation did not complete successfully because the network communication or the remote service timed out