|
Remote Systems v6.4.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Field Summary | |
---|---|
static String |
copyright
|
Fields inherited from interface com.ibm.etools.systems.subsystems.IRemoteObjectResolver |
---|
Copyright |
Method Summary | |
---|---|
void |
checkIsConnected()
This is a helper method you can call when performing actions that must be certain there is a connection. |
void |
clearLocalUserId()
Called to clear the local user Id such that subsequent requests to getUserId() will return the parent connection's default user Id. |
void |
connect()
Connect to the remote system. |
void |
connect(Shell shell)
Connect to the remote system. |
void |
connect(Shell shell,
boolean forcePrompt)
Connect to the remote system, optionally forcing a signon prompt even if the password is cached in memory or on disk. |
void |
deletingConnection()
Private method called when the parent connection is being deleted, so the subsystem can do any pre-death cleanup it needs to. |
void |
disconnect(Shell shell)
Disconnect from the remote system. |
void |
disconnect(Shell shell,
boolean collapseTree)
Disconnect from the remote system. |
boolean |
doesFilterListContentsOf(SystemFilter filter,
String remoteObjectAbsoluteName)
Return true if the given filter lists the contents of the given remote object. |
boolean |
doesFilterMatch(SystemFilter filter,
String remoteObjectAbsoluteName)
Return true if the given remote object name will pass the filtering criteria for any of the filter strings in this filter. |
boolean |
doesFilterStringListContentsOf(SystemFilterString filterString,
String remoteObjectAbsoluteName)
Return true if the given filter string lists the contents of the given remote object. |
boolean |
doesFilterStringMatch(String filterString,
String remoteObjectAbsoluteName,
boolean caseSensitive)
Return true if the given remote object name will pass the filtering criteria for the given filter string in this filter. |
boolean |
forceUserIdToUpperCase()
Return true if userId and password should be forced to uppercase. |
String |
getAdditionalAttributes()
Private. |
ICacheManager |
getCacheManager()
Return the CacheManager for this subsystem. |
Object[] |
getChildren()
Return the children for this subsystem. |
RemoteCmdSubSystem |
getCommandSubSystem()
Return the associated command subsystem. |
String |
getFactoryId()
|
SystemFilterPoolReferenceManager |
getFilterPoolReferenceManager()
Generated persistent property method Return the object that manages the list of filter pools referenced by this subsystem. |
String |
getIbmAttributes()
Private. |
String |
getLocalUserId()
Alternative to getUserId when we don't want to resolve it from parent connection. |
String |
getName()
|
SubSystemFactory |
getParentSubSystemFactory()
Return the parent subsystem factory that owns this subsystem. |
Integer |
getPort()
|
int |
getPortAsInt()
Return the port for this subsystem, as an integer. |
SubSystem |
getPrimarySubSystem()
Return the primary subsystem associated with this subsystem's ISystem |
String[] |
getProperties(Object subject,
String[] keys,
Shell shell)
Get a remote property. |
String |
getProperty(Object subject,
String key,
Shell shell)
Get a remote property. |
PropertyPage |
getPropertyPage(Composite parent)
Return the single property page to show in the tabbed notebook for the for SubSystem property of the parent Connection. |
ServerLauncher |
getRemoteServerLauncher()
Returns the value of the 'Remote Server Launcher' containment reference. |
String |
getSaveFileName()
Return the unqualified file name to save this subsystem to. |
ISystem |
getSystem()
Return the ISystem object that represents the live connection for this system. |
SystemConnection |
getSystemConnection()
Return the connection object this subsystem is associated with. |
String |
getSystemConnectionName()
|
SystemFilterPoolReferenceManager |
getSystemFilterPoolReferenceManager()
Return the system filter pool reference manager, as per the interface SystemFilterPoolReferenceManagerProvider |
AbstractSystemManager |
getSystemManager()
Return a singleton instance of an AbstractSystemManager subclass that manages a pool of ISystem objects, one per system connection. |
SystemProfile |
getSystemProfile()
Return the system profile object this subsystem is associated with. |
String |
getSystemProfileName()
|
Object |
getTargetForFilter(SystemFilterReference filterRef)
Returns the parent object associated with a filter reference. |
SystemUDActionSubsystem |
getUDActionSubsystem()
Return the User Actions and Types manager for the parent subsystem factory of this subsystem |
String |
getUserId()
Returns the value of this subsystem's user id if it is not null. |
String |
getVendorAttribute(String vendorName,
String attributeName)
For business partners defining their own subsystems. |
String |
getVendorAttributes()
Private. |
boolean |
hasChildren()
Return true if this subsystem has children objects to be displayed in the Remote System View explorer. |
boolean |
isConnected()
Return true if this subsystem is currently connected to its remote system. |
boolean |
isConnectionError()
Return true if the last attempt to connect this subsystem to its remote system failed. |
boolean |
isHidden()
Generated persistent property method Return true if this subsystem is to be hidden so it doesn't show in the Remote Systems view when a connection is expanded. |
boolean |
isOffline()
Return true if this subsystem is currently being used in "offline" mode. |
boolean |
isSetAdditionalAttributes()
Private. |
boolean |
isSetIbmAttributes()
Private. |
boolean |
isSetVendorAttributes()
Private. |
boolean |
isUseSSL()
Generated persistent property method Return true if this connection is to use SSL. |
void |
renamingConnection(String newName)
Private method called when the parent connection is being renamed, so the subsystem can do any cleanup it needs to. |
void |
renamingProfile(String oldName,
String newName)
Private method called when the parent profile is being renamed, so the subsystem can do any cleanup it needs to. |
Object[] |
resolveFilterString(IProgressMonitor monitor,
Object parent,
String filterString)
Modal thread version of resolve filter strings Resolve an absolute filter string. |
Object[] |
resolveFilterString(IProgressMonitor monitor,
String filterString)
Modal thread version of resolve filter strings Resolve an absolute filter string. |
Object[] |
resolveFilterString(Object parent,
String filterString,
Shell shell)
Resolve an relative filter string. |
Object[] |
resolveFilterString(String filterString,
Shell shell)
Resolve an absolute filter string. |
Object[] |
resolveFilterStrings(IProgressMonitor monitor,
String[] filterStrings)
Modal thread version of resolve filter strings Resolve an absolute filter string. |
Object[] |
resolveFilterStrings(String[] filterStrings,
Shell shell)
Resolve multiple absolute filter strings. |
void |
setAdditionalAttributes(String value)
Private. |
void |
setConnectionError(boolean error)
Sets whether the last attempt to connect this subsystem to its remote system failed. |
void |
setFactoryId(String value)
|
void |
setFilterPoolReferenceManager(SystemFilterPoolReferenceManager value)
Generated persistent property method Set the object that manages the list of filter pools referenced by this subsystem. |
void |
setHidden(boolean value)
Generated persistent property method Specify true if this subsystem is to be hidden so it doesn't show in the Remote Systems view when a connection is expanded. |
void |
setIbmAttributes(String value)
Private. |
void |
setName(String value)
|
void |
setParentConnection(SystemConnection conn)
Set the parent connection that owns this subsystem. |
void |
setParentSubSystemFactory(SubSystemFactory ssf)
Set the parent subsystem factory that owns this subsystem. |
void |
setPort(Integer value)
|
Object |
setProperties(Object subject,
String[] keys,
String[] values,
Shell shell)
Set multiple remote properties. |
Object |
setProperty(Object subject,
String key,
String value,
Shell shell)
Set a remote property. |
void |
setRemoteServerLauncher(ServerLauncher value)
Sets the value of the ' Remote Server Launcher ' containment reference |
void |
setSaveFileName(String name)
Set the unqualified file name to save this subsystem to. |
void |
setUserId(String value)
Sets the local userId for this subsystem. |
void |
setUseSSL(boolean value)
Generated persistent property method Specify true if this connection is to use SSL. |
void |
setVendorAttribute(String vendorName,
String attributeName,
String attributeValue)
For business partners defining their own subsystems. |
void |
setVendorAttributes(String value)
Private. |
boolean |
supportsCaching()
Check if the SubSystem supports caching. |
void |
unsetAdditionalAttributes()
Private. |
void |
unsetIbmAttributes()
Private. |
void |
unsetVendorAttributes()
Private. |
Methods inherited from interface com.ibm.etools.systems.subsystems.IRemoteObjectResolver |
---|
getObjectWithAbsoluteName |
Field Detail |
public static final String copyright
Method Detail |
public RemoteCmdSubSystem getCommandSubSystem()
public SubSystemFactory getParentSubSystemFactory()
public void setParentSubSystemFactory(SubSystemFactory ssf)
public void setParentConnection(SystemConnection conn)
public SystemProfile getSystemProfile()
getName()
public SystemConnection getSystemConnection()
public SubSystem getPrimarySubSystem()
public String getSystemConnectionName()
public String getSystemProfileName()
public void renamingProfile(String oldName, String newName)
public void renamingConnection(String newName)
public void deletingConnection()
public void checkIsConnected() throws SystemMessageException
SystemMessageException
public PropertyPage getPropertyPage(Composite parent)
public void setVendorAttribute(String vendorName, String attributeName, String attributeValue)
public String getVendorAttribute(String vendorName, String attributeName)
public boolean forceUserIdToUpperCase()
public String getLocalUserId()
Unlike getUserId() this one does not defer to the connection's default user Id if the subsystem's userId attribute is null.
To set the local user Id, simply call setUserId(String id). To clear it, call
clearLocalUserId()
.
SystemConnection.getDefaultUserId()
,
clearLocalUserId()
,
getUserId()
,
setUserId(String)
public void clearLocalUserId()
SystemConnection.getDefaultUserId()
,
getUserId()
,
getLocalUserId()
,
setUserId(String)
public Object[] getChildren()
By default, if the parent subsystem factory supports filters, then we return getSystemFilterPoolReferencesArray. If filters are not supported (supportsFilters() returns false from factory) then we return null. In this case you should override this.
public boolean hasChildren()
public void setSaveFileName(String name)
It is important the name end with "_subsystem", so we can deduce it is a subsystem file, so this will be appended if not found.
public String getSaveFileName()
In release 1.0, returned getName(). However, this is a translated name hence caused problems in a multi-linqual team environment.
As of release 2.0, this now returns the last part of the id of the parent factory, plus "_subsystem". For example, for "ibm.filesLocal" it returns "filesLocal_subsystem".
This can be overridden by calling setSaveFileName.
public boolean doesFilterListContentsOf(SystemFilter filter, String remoteObjectAbsoluteName)
The default algorithm calls doesFilterStringListContentsOf for each filter string.
public boolean doesFilterStringListContentsOf(SystemFilterString filterString, String remoteObjectAbsoluteName)
public boolean doesFilterMatch(SystemFilter filter, String remoteObjectAbsoluteName)
public boolean doesFilterStringMatch(String filterString, String remoteObjectAbsoluteName, boolean caseSensitive)
public SystemFilterPoolReferenceManager getSystemFilterPoolReferenceManager()
getSystemFilterPoolReferenceManager
in interface SystemFilterPoolReferenceManagerProvider
public String getName()
public void setName(String value)
value
- The new value of the Name attributepublic String getUserId()
In fact, we now don't store the user Id in the subsystem object itself, but rather store it in the user preferences, so that such things are not shared among the team on a synchronize operation. This is transparent to callers of this method however, as this method resolves from the preferences.
SystemConnection.getDefaultUserId()
,
setUserId(String)
,
getLocalUserId()
,
clearLocalUserId()
public void setUserId(String value)
Behind the scenes, the user Id is in fact not stored in this subsystem object. Rather, it is
stored in the user's preferences and the key value for that preference value is stored in the
subsystem object. The methods getUserId()
and getLocalUserId()
will take care
of resolving from the user preferences and returning the resolved value.
We store the userId in the user preferences to they are not shared among the team when the remote systems project is synchronized with a repository.
value
- The new value of the UserId attribute. If it is null, then this is the same as
calling clearLocalUserId()
.public Integer getPort()
public int getPortAsInt()
public void setPort(Integer value)
value
- The new value of the Port attributepublic String getFactoryId()
public void setFactoryId(String value)
value
- The new value of the FactoryId attributepublic ISystem getSystem()
public AbstractSystemManager getSystemManager()
public boolean supportsCaching()
public ICacheManager getCacheManager()
supportsCaching()
public boolean isConnected()
public boolean isConnectionError()
public void setConnectionError(boolean error)
public boolean isOffline()
public void connect(Shell shell) throws Exception
Exception
public void connect() throws Exception
Exception
public void connect(Shell shell, boolean forcePrompt) throws Exception
forcePrompt
- forces the prompt dialog to be displayed even if the password is currently
in memory.
Exception
public void disconnect(Shell shell) throws Exception
Exception
public void disconnect(Shell shell, boolean collapseTree) throws Exception
Exception
public Object[] resolveFilterString(IProgressMonitor monitor, String filterString) throws Exception
When a user expands a filter containing filter strings, this method is invoked for each filter string.
The resulting objects are displayed in the remote system view tree. They can be anything, but at a minimum must support IAdaptable in order to drive the property sheet. You can just defer the getAdapter request to the platform's Adapter manager if desired.
You should supply an adapter class for the returned object's class, to render objects in the Remote System Explorer view. It will uses a label and content provider that defers all requests to the adapter, which it gets by querying the platform's adapter manager for the object type. Be sure to register your adapter factory.
monitor
- the process monitor associated with this operationfilterString
- filter pattern for objects to return.
Exception
public Object[] resolveFilterStrings(IProgressMonitor monitor, String[] filterStrings) throws Exception
When a user expands a filter containing filter strings, this method is invoked for each filter string.
The resulting objects are displayed in the remote system view tree. They can be anything, but at a minimum must support IAdaptable in order to drive the property sheet. You can just defer the getAdapter request to the platform's Adapter manager if desired.
You should supply an adapter class for the returned object's class, to render objects in the Remote System Explorer view. It will uses a label and content provider that defers all requests to the adapter, which it gets by querying the platform's adapter manager for the object type. Be sure to register your adapter factory.
monitor
- the process monitor associated with this operationfilterStrings
- filter patterns for objects to return.
Exception
public Object[] resolveFilterString(IProgressMonitor monitor, Object parent, String filterString) throws Exception
When a user expands a filter containing filter strings, this method is invoked for each filter string.
The resulting objects are displayed in the remote system view tree. They can be anything, but at a minimum must support IAdaptable in order to drive the property sheet. You can just defer the getAdapter request to the platform's Adapter manager if desired.
You should supply an adapter class for the returned object's class, to render objects in the Remote System Explorer view. It will uses a label and content provider that defers all requests to the adapter, which it gets by querying the platform's adapter manager for the object type. Be sure to register your adapter factory.
monitor
- the process monitor associated with this operationparent
- the parent object to queryfilterString
- filter pattern for objects to return.
Exception
public Object[] resolveFilterString(String filterString, Shell shell) throws Exception
When a user expands a filter containing filter strings, this method is invoked for each filter string.
The resulting objects are displayed in the remote system view tree. They can be anything, but at a minimum must support IAdaptable in order to drive the property sheet. You can just defer the getAdapter request to the platform's Adapter manager if desired.
You should supply an adapter class for the returned object's class, to render objects in the Remote System Explorer view. It will uses a label and content provider that defers all requests to the adapter, which it gets by querying the platform's adapter manager for the object type. Be sure to register your adapter factory.
filterString
- filter pattern for objects to return.
Exception
public Object[] resolveFilterStrings(String[] filterStrings, Shell shell) throws Exception
This is the same as resolveFilterString(String,Shell)
but takes an array of
filter strings versus a single filter string.
filterStrings
- array of filter patterns for objects to return.
Exception
public Object[] resolveFilterString(Object parent, String filterString, Shell shell) throws Exception
When a user expands an object that came from a previous filter string expansion, (such as expanding a folder), this method is invoked to get the children of that object. The user can choose to expand all, or choose a pre-defined relative filter string to subset/filter the children. In either case, the relative filter string is passed in as well as the to-be-expanded parent object.
The resulting objects are displayed in the remote system view tree. They can be anything, but at a minimum must support IAdaptable in order to drive the property sheet. You can just defer the getAdapter request to the platform's Adapter manager if desired.
You should supply an adapter class for the returned object's class, to render objects in the Remote System Explorer view. It will uses a label and content provider that defers all requests to the adapter, which it gets by querying the platform's adapter manager for the object type. Be sure to register your adapter factory.
parent
- Object that is being expanded.filterString
- filter pattern for children of parent.
Exception
public Object setProperty(Object subject, String key, String value, Shell shell) throws Exception
subject
- Identifies which object to get the properties ofkey
- Identifies property to setvalue
- Value to set property to
Exception
public String getProperty(Object subject, String key, Shell shell) throws Exception
subject
- Identifies which object to get the properties ofkey
- Identifies property to get value of
Exception
public Object setProperties(Object subject, String[] keys, String[] values, Shell shell) throws Exception
subject
- Identifies which object to get the properties of
Exception
public String[] getProperties(Object subject, String[] keys, Shell shell) throws Exception
subject
- Identifies which object to get the properties of
Exception
public SystemUDActionSubsystem getUDActionSubsystem()
public boolean isHidden()
public void setHidden(boolean value)
value
- The new value of the Hidden attributepublic SystemFilterPoolReferenceManager getFilterPoolReferenceManager()
public void setFilterPoolReferenceManager(SystemFilterPoolReferenceManager value)
public String getVendorAttributes()
getVendorAttribute(String,String)
public void setVendorAttributes(String value)
setVendorAttribute(String,String,String)
value
- The new value of the VendorAttributes attributepublic void unsetVendorAttributes()
public boolean isSetVendorAttributes()
public String getAdditionalAttributes()
public void setAdditionalAttributes(String value)
value
- The new value of the AdditionalAttributes attributepublic void unsetAdditionalAttributes()
public boolean isSetAdditionalAttributes()
public boolean isUseSSL()
public void setUseSSL(boolean value)
value
- The new value of the UseSSL attributepublic String getIbmAttributes()
com.ibm.etools.systems.subsystems.impl.SubSystemImpl.#getIBMAttribute(String)
public void setIbmAttributes(String value)
com.ibm.etools.systems.subsystems.impl.SubSystemImpl.#setIBMAttribute(String,String)
value
- The new value of the IbmAttributes attributepublic void unsetIbmAttributes()
public boolean isSetIbmAttributes()
public ServerLauncher getRemoteServerLauncher()
Parent Sub System
'.
Get the remote server launcher, which may be null. This an optional object containing properties used to launch the remote server that communicates with this subsystem.
setRemoteServerLauncher(ServerLauncher)
,
SubsystemsPackage.getSubSystem_RemoteServerLauncher()
,
ServerLauncher.getParentSubSystem()
public void setRemoteServerLauncher(ServerLauncher value)
Remote Server Launcher
' containment reference.
Set the remote server launcher, which is an optional object containing
properties used to launch the remote server that communicates with this subsystem.
value
- the new value of the 'Remote Server Launcher' containment reference.getRemoteServerLauncher()
public Object getTargetForFilter(SystemFilterReference filterRef)
filterRef
- the filter reference to determine a target object from.
|
Remote Systems v6.4.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |