|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface CARMA
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:
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 |
|---|
static final java.lang.String copyright
| Method Detail |
|---|
java.lang.String getIdentifier()
setIdentifier(String),
ModelPackage.getCARMA_Identifier()void setIdentifier(java.lang.String value)
Identifier' attribute.
value - the new value of the 'Identifier' attribute.getIdentifier()
org.eclipse.emf.common.util.EList getRepositoryManagers()
throws NotSynchronizedException
RepositoryManager.
It is bidirectional and its opposite is 'CARMA'.
List of the Repository types available on the CARMA server.
NotSynchronizedException - Exeception is thrown when the a refresh operation is required because the Repository
Manager List has not been initialized.isSetRepositoryManagers(),
refresh(IProgressMonitor),
ModelPackage.getCARMA_RepositoryManagers(),
RepositoryManager.getCARMA()boolean isSetRepositoryManagers()
Repository Managers' containment reference list is set.
This returns true if the Repository Managers list has been initialized.
getRepositoryManagers()
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
pm - The progress monitor for the connect operation
org.eclipse.core.runtime.CoreException - An error occured when connecting to the CARMA host when the connection could not be formed
@Deprecated
void connect(org.eclipse.core.runtime.IProgressMonitor pm,
java.lang.String username,
java.lang.String password)
throws org.eclipse.core.runtime.CoreException
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
pm - The progress monitor for the connect operationusername - 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.
org.eclipse.core.runtime.CoreException - An error occured when connecting to the CARMA host when the connection could not be formed
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
pm - The progress monitor for the disconnect operation
org.eclipse.core.runtime.CoreException - An error occured when disconnecting from the CARMA host where the connection could shut down
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.
pm - The progress monitor for the operation
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.boolean isConnected()
"false".
Returns true when the CARMA instance is actively connected to the host.
ModelPackage.getCARMA_Connected()java.lang.String getBackendId()
ModelPackage.getCARMA_BackendId()java.util.Locale getLocale()
setLocale(Locale),
ModelPackage.getCARMA_Locale()void setLocale(java.util.Locale value)
Locale' attribute.
value - the new value of the 'Locale' attribute.getLocale()
void setLocale(java.lang.String value)
throws java.lang.IllegalArgumentException
Locale' attribute.
value - the new String representation of the 'Locale' attribute.
java.lang.IllegalArgumentException - error occuring while converting the string value to a locale objectgetLocale()org.eclipse.emf.common.util.EMap getConnectionProperties()
String,
and the value is of type String,
Properties used to create the specific CARMA transport layer connection for the CARMA connection instance.
ModelPackage.getCARMA_ConnectionProperties()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||