Overview  Package    Class   Use  Tree  Deprecated  Index  Help		RSE Release 3.0
PREV CLASS    NEXT CLASS	NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR |  METHOD	DETAIL: FIELD | CONSTR |  METHOD

---

org.eclipse.rse.core.model
Interface ISystemProfile

All Superinterfaces:

IPropertySetContainer, IRSEModelObject, IRSEPersistableContainer

---

public interface ISystemProfile
extends 
IRSEModelObject

A system profile holds definitions for hosts (connections), filter pools, filters, and filter strings. It is the unit of persistence for those definitions. Individual hosts and filter pool definitions always reside in a profile and the profile itself is the entity that is saved and restored.

Profiles may be active or inactive. An active profile contributes its definitions to RSE. When made inactive, it those definition are no longer available for use.

---

Field Summary

 

Fields inherited from interface org.eclipse.rse.core.model. IRSEPersistableContainer
NO_CHILDREN

 

Method Summary
ISystemFilterPool[]	getFilterPools ()
ISystemFilterPool[]	getFilterPools ( ISubSystemConfiguration ssf)           Return all filter pools for this profile, scoped by a given subsystem factory
IHost[]	getHosts ()           Return all connections for this profile
String	getName ()
IRSEPersistenceProvider	getPersistenceProvider ()           Each profile is persisted by a persistence provider.
ISystemProfileManager	getProfileManager ()           Get the in-memory pointer back to the parent system profile manager
boolean	isActive ()           Return true if this profile is currently active.
boolean	isDefaultPrivate ()
boolean	isSuspended ()
void	resume ()           Resume this profile from a suspended state.
void	setActive (boolean flag)           Activates or deactivates a profile.
void	setDefaultPrivate (boolean value)
void	setName ( String value)           Sets the name of the profile.
void	setPersistenceProvider ( IRSEPersistenceProvider provider)           Sets the persistence provider for the use of this profile.
void	setProfileManager ( ISystemProfileManager mgr)           Set the in-memory pointer back to the parent system profile manager
void	suspend ()           Suspend this profile.

 

Methods inherited from interface org.eclipse.rse.core.model. IRSEModelObject
getDescription

 

Methods inherited from interface org.eclipse.rse.core.model. IPropertySetContainer
addPropertySet, addPropertySets, createPropertySet, createPropertySet, getPropertySet, getPropertySets, removePropertySet

 

Methods inherited from interface org.eclipse.rse.core.model. IRSEPersistableContainer
commit, getPersistableChildren, getPersistableParent, isDirty, isTainted, setDirty, setTainted, setWasRestored, wasRestored

 

Method Detail

setProfileManager

void setProfileManager(
ISystemProfileManager mgr)

Set the in-memory pointer back to the parent system profile manager

---

getProfileManager

ISystemProfileManager getProfileManager()

Get the in-memory pointer back to the parent system profile manager

---

getName

String getName()

Specified by:

getName in interface IRSEModelObject

Returns:

The value of the Name attribute

---

setName

void setName(
String value)

Sets the name of the profile. Profile names must not contain three consecutive underscores "___", since these are used to separate a profile name from a filter pool name in a filter pool reference.

Parameters:

value - The new value of the Name attribute

Throws:

IllegalArgumentException - if the name contains three consecutive underscore characters.

---

isDefaultPrivate

boolean isDefaultPrivate()

Returns:

The value of the DefaultPrivate attribute Is this profile created automatically, and is it the profile that is unique for this developer?

---

setDefaultPrivate

void setDefaultPrivate(boolean value)

Parameters:

value - The new value of the DefaultPrivate attribute

---

getHosts

IHost[] getHosts()

Return all connections for this profile

---

getFilterPools

ISystemFilterPool[] getFilterPools()

Returns:

all existing filter pools for this profile.

---

getFilterPools

ISystemFilterPool[] getFilterPools(
ISubSystemConfiguration ssf)

Return all filter pools for this profile, scoped by a given subsystem factory

---

isActive

boolean isActive()

Return true if this profile is currently active. An active profile is one that whose connections and filter pools are available for use by RSE. A profile may be loaded but be inactive. The active state of a profile is remembered from session to session.

---

setActive

void setActive(boolean flag)

Activates or deactivates a profile. If the profile is already in the requested state, this will do nothing. The default private system profile cannot be deactivated and such a request will be ignored.

Parameters:

flag - true to activate the profile, false to deactivate it.

See Also:

isActive()

---

suspend

void suspend()

Suspend this profile. Suspended profiles ignore commit requests. Profiles are created in a non-suspended state. Profiles should be suspended while deleting their contents prior to their own deletion. Note that being non-suspended is a different condition than being active. A suspended profile may be resumed.

Since:

3.0

See Also:

resume()

---

resume

void resume()

Resume this profile from a suspended state. The profile will now honor commit requests.

Since:

3.0

See Also:

suspend()

---

isSuspended

boolean isSuspended()

Returns:

true if the profile is in a suspended state

Since:

3.0

See Also:

suspend(), resume()

---

getPersistenceProvider

IRSEPersistenceProvider getPersistenceProvider()

Each profile is persisted by a persistence provider. This returns the instance of the persistence provider used for this profile. New profiles will use the default persistence provider unless one is set by some other means.

Returns:

The persistence provider used for saving and restoring this profile.

---

setPersistenceProvider

void setPersistenceProvider(
IRSEPersistenceProvider provider)

Sets the persistence provider for the use of this profile. If this is not called then this profile will be persisted by the default persistence provider. This will typically be set by either a persistence persistence provider when restoring a profile or by a migration utility when converting profiles from one form to another.

Parameters:

provider - the persistence provider to use when saving this profile.

---

Overview  Package    Class   Use  Tree  Deprecated  Index  Help		RSE Release 3.0
PREV CLASS    NEXT CLASS	NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR |  METHOD	DETAIL: FIELD | CONSTR |  METHOD

---

Copyright (c) IBM Corporation and others 2000, 2008. All Rights Reserved.