org.eclipse.stp.core.saf
Interface ISAFManager


public interface ISAFManager

This interface allows interaction with the SOA Assembly Framework. It is implemented by a singleton class that can be accessed by the INSTANCE element. This interface is not intended to be implemented by client tools.


Field Summary
static ISAFManager INSTANCE
          Use this interface to access the ISAFManager singleton implementation.
static boolean REFERENCE
          Flag representing a reference set.
static boolean SERVICE
          Flag representing an interface set.
 
Method Summary
 IComponentHandler[] getAllComponentHandlers(Context context)
          Returns an array of IComponentHandler for all supported component kinds.
 IEntryPointHandler[] getAllEntryPointHandlers(Context context)
          Returns an array of IEntryPointHandler for all supported entry point kinds.
 IExternalServiceHandler[] getAllExternalServiceHandlers(Context context)
          Returns an array of IExternalServiceHandler for all supported external service kinds.
 IInterfaceHandler[] getAllInterfaceHandlers()
          Returns an array of IInterfaceHandler for all available interface kinds.
 IComponentHandler[] getComponentHandlersFor(Context context, java.lang.Object implementationObj)
          This method calls the canCreateComponentFor() method of all component handlers, passing the implementation model object.
 java.lang.String getDefaultComponentKind()
          Returns the QName string for the default component implementation-neutral type.
 IEntryPointHandler[] getEntryPointHandlersFor(Context context, java.lang.Object service)
          This method calls the IEntryPointHandler.canCreateEntryPointFor(Object) method of all external service handlers, passing the service model object.
 IExternalServiceHandler[] getExternalServiceHandlersFor(Context context, java.lang.Object service)
          This method calls the IExternalServiceHandler.canCreateExternalServiceFor(Object) method of all external service handlers, passing the service model object.
 IComponentHandler getHandlerFor(org.eclipse.stp.core.sca.Component theComponent)
          Returns the IComponentHandler for the kind of the specified component or returns null if the component has no kind.
 IInterfaceHandler getHandlerFor(org.eclipse.stp.core.sca.Interface theInterface)
          Returns the IInterfaceHandler for the kind of the specified interface or returns null if the interface has no kind.
 IEntryPointHandler[] getHandlersFor(org.eclipse.stp.core.sca.EntryPoint theEntryPoint)
          Returns a IEntryPointHandler for the entry point kind of the specified entry point or returns null if the entry point has no binding.
 IExternalServiceHandler[] getHandlersFor(org.eclipse.stp.core.sca.ExternalService theExternalService)
          Returns a IExternalServiceHandler for the external service kind of the specified external service or returns null if the external service has no binding.
 IInterfaceHandler[] getInterfaceHandlersFor(java.lang.Object interfaceObj)
          This method calls the IInterfaceHandler.canCreateInterfaceFor(Object) method of all interface handlers, passing the object.
 

Field Detail

INSTANCE

public static final ISAFManager INSTANCE
Use this interface to access the ISAFManager singleton implementation.


SERVICE

public static final boolean SERVICE
Flag representing an interface set. This value is provided for use with isInterfaceKindSupportedForComponent().

See Also:
Constant Field Values

REFERENCE

public static final boolean REFERENCE
Flag representing a reference set. This value is provided for use with isInterfaceKindSupportedForComponent().

See Also:
Constant Field Values
Method Detail

getAllComponentHandlers

public IComponentHandler[] getAllComponentHandlers(Context context)
Returns an array of IComponentHandler for all supported component kinds.

Parameters:
context - the object that can be used to filter the resulting set of component handlers to show only the ones that are valid for the given context
Returns:
an array of component handlers

getAllExternalServiceHandlers

public IExternalServiceHandler[] getAllExternalServiceHandlers(Context context)
Returns an array of IExternalServiceHandler for all supported external service kinds.

Parameters:
context - the object that can be used to filter the resulting set of external service handlers to show only the ones that are valid for the given context
Returns:
an array of external service handlers

getAllEntryPointHandlers

public IEntryPointHandler[] getAllEntryPointHandlers(Context context)
Returns an array of IEntryPointHandler for all supported entry point kinds.

Parameters:
context - the object that can be used to filter the resulting set of entry point handlers to show only the ones that are valid for the given context
Returns:
an array of entry point handlers

getAllInterfaceHandlers

public IInterfaceHandler[] getAllInterfaceHandlers()
Returns an array of IInterfaceHandler for all available interface kinds.

Returns:
an array of interface handlers

getComponentHandlersFor

public IComponentHandler[] getComponentHandlersFor(Context context,
                                                   java.lang.Object implementationObj)
This method calls the canCreateComponentFor() method of all component handlers, passing the implementation model object. Each of the handlers that returns true is returned in the resulting array. Each handler in the array represents a kind of component that can be created for the specified implementation model object. An empty array is returned if no matching handler is found.

Parameters:
implementationObj - an object that could provide the implementation for a component
context - the object that can be used to filter the resulting set of kind component handlers to show only the ones that are valid for the given context
Returns:
an array of component handlers

getDefaultComponentKind

public java.lang.String getDefaultComponentKind()
Returns the QName string for the default component implementation-neutral type.

Returns:
QName string for the appropriate component type

getHandlerFor

public IComponentHandler getHandlerFor(org.eclipse.stp.core.sca.Component theComponent)
Returns the IComponentHandler for the kind of the specified component or returns null if the component has no kind. The handler provides information about the component kind that could be presented to an end user. If no component handler supports the component kind, null is returned.

Parameters:
theComponent - the component whose handler is returned
Returns:
the handler for the specified component

getHandlerFor

public IInterfaceHandler getHandlerFor(org.eclipse.stp.core.sca.Interface theInterface)
Returns the IInterfaceHandler for the kind of the specified interface or returns null if the interface has no kind. The handler provides information about the interface kind that could be presented to an end user. If no interface handler supports the interface kind, null is returned.

Parameters:
theInterface - the interface whose handler is returned
Returns:
the handler for the specified interface

getExternalServiceHandlersFor

public IExternalServiceHandler[] getExternalServiceHandlersFor(Context context,
                                                               java.lang.Object service)
This method calls the IExternalServiceHandler.canCreateExternalServiceFor(Object) method of all external service handlers, passing the service model object. Each of the handlers that returns true is returned in the resulting array. Each handler in the array represents a kind of external service binding that can be created for the specified service model object. Each handler provides information about the external service kind that could be presented to an end user. An empty array is returned if no matching handler is found.

Parameters:
context - the object that can be used to filter the resulting set of handlers, depending on which ones are valid for the given context
service - the object representing a service to be imported
Returns:
an array of external service handlers

getHandlersFor

public IExternalServiceHandler[] getHandlersFor(org.eclipse.stp.core.sca.ExternalService theExternalService)
Returns a IExternalServiceHandler for the external service kind of the specified external service or returns null if the external service has no binding. The handler provides information about the binding kind that could be presented to an end user. If no external service handler supports the external service kind, null is returned.

Parameters:
theExternalService - the external service whose handler is returned
Returns:
an array of handlers for the specified external service

getEntryPointHandlersFor

public IEntryPointHandler[] getEntryPointHandlersFor(Context context,
                                                     java.lang.Object service)
This method calls the IEntryPointHandler.canCreateEntryPointFor(Object) method of all external service handlers, passing the service model object. Each of the handlers that returns true is returned in the resulting array. Each handler in the array represents a kind of entry point binding that can be created for the specified service model object. Each handler provides information about the entry point kind that could be presented to an end user. An empty array is returned if no matching handler is found.

Parameters:
context - the object that can be used to filter the resulting set of handlers, depending on which ones are valid for the given context
service - the object representing a service to be exposed
Returns:
an array of entry point handlers

getHandlersFor

public IEntryPointHandler[] getHandlersFor(org.eclipse.stp.core.sca.EntryPoint theEntryPoint)
Returns a IEntryPointHandler for the entry point kind of the specified entry point or returns null if the entry point has no binding. The handler provides information about the binding kind that could be presented to an end user. If no entry point handler supports the entry point kind, null is returned.

Parameters:
theEntryPoint - the entry point whose handler is returned
Returns:
an array of handlers for the specified entry point

getInterfaceHandlersFor

public IInterfaceHandler[] getInterfaceHandlersFor(java.lang.Object interfaceObj)
This method calls the IInterfaceHandler.canCreateInterfaceFor(Object) method of all interface handlers, passing the object. Each of the handlers that returns true is returned in the resulting array. Each handler in the array represents a kind of interface that can be created for the specified model object. Each handler provides information about the interface kind that could be presented to an end user. An empty array is returned if no matching handler is found.

Parameters:
interfaceObj - the object representing the interface
Returns:
an array of interface handlers for the specified object