com.ibm.carma.model
Interface CARMA

All Superinterfaces:
Convertable, org.eclipse.emf.ecore.EObject, org.eclipse.core.runtime.IAdaptable, org.eclipse.emf.common.notify.Notifier, TransportConnectionListener

public interface CARMA
extends Convertable, TransportConnectionListener, org.eclipse.core.runtime.IAdaptable

A representation of the model object 'CARMA'. Object instance provides access to host-based CARMA functionality. The CARMA object represents as well as maintains the connection to the CARMA host.

The following features are supported:

See Also:
ModelPackage.getCARMA(), CARMASystemFactory

Field Summary
static java.lang.String copyright
           
 
Method Summary
 void connect(org.eclipse.core.runtime.IProgressMonitor pm)
           
 void connect(org.eclipse.core.runtime.IProgressMonitor pm, java.lang.String username, java.lang.String password)
          Deprecated. use the connect(IProgressMonitor) method and allow the transport to handle the id/password query
 void disconnect(org.eclipse.core.runtime.IProgressMonitor pm)
           
 java.lang.String getBackendId()
          Returns the value of the 'Backend Id' attribute.
 org.eclipse.emf.common.util.EMap getConnectionProperties()
          Returns the value of the 'Connection Properties' map.
 java.lang.String getIdentifier()
          Returns the value of the 'Identifier' attribute.
 java.util.Locale getLocale()
          Returns the value of the 'Locale' attribute.
 org.eclipse.emf.common.util.EList getRepositoryManagers()
          Returns the value of the 'Repository Managers' containment reference list.
 boolean isConnected()
          Returns the value of the 'Connected' attribute.
 boolean isSetRepositoryManagers()
          Returns whether the value of the 'Repository Managers' containment reference list is set.
 void refresh(org.eclipse.core.runtime.IProgressMonitor pm)
           
 void setIdentifier(java.lang.String value)
          Sets the value of the 'Identifier' attribute.
 void setLocale(java.util.Locale value)
          Sets the value of the 'Locale' attribute.
 void setLocale(java.lang.String value)
          Sets the value of the 'Locale' attribute.
 
Methods inherited from interface com.ibm.carma.model.Convertable
getBidiOptions, getBidiOptionsFile, getLocalCodepage, getRemoteCodepage, isSetBidiOptions, isSetBidiOptionsFile, isSetLocalCodepage, isSetRemoteCodepage, setBidiOptions, setBidiOptionsFile, setLocalCodepage, setRemoteCodepage, unsetBidiOptions, unsetBidiOptionsFile, unsetLocalCodepage, unsetRemoteCodepage
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 
Methods inherited from interface com.ibm.carma.model.TransportConnectionListener
connectionStateChanged
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
 

Field Detail

copyright

static final java.lang.String copyright

See Also:
Constant Field Values
Method Detail

getIdentifier

java.lang.String getIdentifier()
Returns the value of the 'Identifier' attribute. The unique identifier of the CARMA instance.

Returns:
the value of the 'Identifier' attribute.
See Also:
setIdentifier(String), ModelPackage.getCARMA_Identifier()

setIdentifier

void setIdentifier(java.lang.String value)
Sets the value of the 'Identifier' attribute.

Parameters:
value - the new value of the 'Identifier' attribute.
See Also:
getIdentifier()

getRepositoryManagers

org.eclipse.emf.common.util.EList getRepositoryManagers()
                                                        throws NotSynchronizedException
Returns the value of the 'Repository Managers' containment reference list. The list contents are of type RepositoryManager. It is bidirectional and its opposite is 'CARMA'. List of the Repository types available on the CARMA server.

Returns:
the value of the 'Repository Managers' containment reference list.
Throws:
NotSynchronizedException - Exeception is thrown when the a refresh operation is required because the Repository Manager List has not been initialized.
See Also:
isSetRepositoryManagers(), refresh(IProgressMonitor), ModelPackage.getCARMA_RepositoryManagers(), RepositoryManager.getCARMA()

isSetRepositoryManagers

boolean isSetRepositoryManagers()
Returns whether the value of the 'Repository Managers' containment reference list is set. This returns true if the Repository Managers list has been initialized.

Returns:
whether the value of the 'Repository Managers' containment reference list is set.
See Also:
getRepositoryManagers()

connect

void connect(org.eclipse.core.runtime.IProgressMonitor pm)
             throws org.eclipse.core.runtime.CoreException

Sets up the connection to the CARMA host so that commands can be sent to the CARMA host.

Activates the connection to the CARMA server

Parameters:
pm - The progress monitor for the connect operation
Throws:
org.eclipse.core.runtime.CoreException - An error occured when connecting to the CARMA host when the connection could not be formed

connect

@Deprecated
void connect(org.eclipse.core.runtime.IProgressMonitor pm,
                        java.lang.String username,
                        java.lang.String password)
             throws org.eclipse.core.runtime.CoreException
Deprecated. use the connect(IProgressMonitor) method and allow the transport to handle the id/password query

Sets up the connection to the CARMA host so that commands can be sent to the CARMA host.

Activates the connection to the CARMA server

Parameters:
pm - The progress monitor for the connect operation
username - the username to use in creating the connection to the CARMA host. Use null to have the transport query for the username/password.
password - the password to use in creating the connection to the CARMA host. Use null to have the transport query for the username/password.
Throws:
org.eclipse.core.runtime.CoreException - An error occured when connecting to the CARMA host when the connection could not be formed

disconnect

void disconnect(org.eclipse.core.runtime.IProgressMonitor pm)
                throws org.eclipse.core.runtime.CoreException

Shuts down and de-allocates resources associated with the connection to the CARMA host for the CARMA connection instance

De-activates the CARMA connection

Parameters:
pm - The progress monitor for the disconnect operation
Throws:
org.eclipse.core.runtime.CoreException - An error occured when disconnecting from the CARMA host where the connection could shut down

refresh

void refresh(org.eclipse.core.runtime.IProgressMonitor pm)
             throws org.eclipse.core.runtime.CoreException,
                    NotConnectedException

Initializes or updates the list of Repository Managers that are available on the CARMA host.

Refresh the cached copy of the CARMA Repository Managers information.

Parameters:
pm - The progress monitor for the operation
Throws:
org.eclipse.core.runtime.CoreException - An error occured during the operation
NotConnectedException - The operation could not commense as the CARMA instance does not have an active connection. A Connect command should be issued.

isConnected

boolean isConnected()
Returns the value of the 'Connected' attribute. The default value is "false". Returns true when the CARMA instance is actively connected to the host.

Returns:
the value of the 'Connected' attribute.
See Also:
ModelPackage.getCARMA_Connected()

getBackendId

java.lang.String getBackendId()
Returns the value of the 'Backend Id' attribute. Identifier of the CARMA transport layer.

Returns:
the value of the 'Backend Id' attribute.
See Also:
ModelPackage.getCARMA_BackendId()

getLocale

java.util.Locale getLocale()
Returns the value of the 'Locale' attribute. The locale of the connection to the CARMA host

Returns:
the value of the 'Locale' attribute.
See Also:
setLocale(Locale), ModelPackage.getCARMA_Locale()

setLocale

void setLocale(java.util.Locale value)
Sets the value of the 'Locale' attribute.

Parameters:
value - the new value of the 'Locale' attribute.
See Also:
getLocale()

setLocale

void setLocale(java.lang.String value)
               throws java.lang.IllegalArgumentException
Sets the value of the 'Locale' attribute.

Parameters:
value - the new String representation of the 'Locale' attribute.
Throws:
java.lang.IllegalArgumentException - error occuring while converting the string value to a locale object
See Also:
getLocale()

getConnectionProperties

org.eclipse.emf.common.util.EMap getConnectionProperties()
Returns the value of the 'Connection Properties' map. The key is of type String, and the value is of type String, Properties used to create the specific CARMA transport layer connection for the CARMA connection instance.

Returns:
the value of the 'Connection Properties' map.
See Also:
ModelPackage.getCARMA_ConnectionProperties()