com.sssw.rts.adminapi
Interface AgiAdmEjbJar

All Superinterfaces:

AgiAdmChanges, AgiAdmDesignElement, AgiAdmElement, AgiAdmElementBase, AgiAdmPropertyBag

public interface AgiAdmEjbJar

extends AgiAdmDesignElement

Implemented by objects that represent deployed Enterprise JavaBeans JARs.

See Also:

AgiAdmElement, AgiAdmDesignElement

Field Summary

static String	EJB_JAR The "EJB JAR" design element type.
static String	PROP_EJB_HOMES The list of EJB Homes of the EJBs that the EJB JAR contains.
static String	PROP_EJB_JNDI_NAMES The list of EJB JNDI names of the EJBs that the EJB JAR contains.
static String	PROP_ENABLED This property allows the caller to manage the "is enabled" status of the EJB JAR.

Fields inherited from interface com.sssw.rts.adminapi.AgiAdmDesignElement

APP_OBJECT, FORM, GENERAL_ELEMENT, IMAGE, JAR, JAVA_BEAN, PAGE, SERVLET, SOUND, TABLE, VIEW

Fields inherited from interface com.sssw.rts.adminapi.AgiAdmElement

ACL_KEY, APPLY_TO_DESC, APPLY_TO_DESC_SUPPORTED, DIRECTORY_LIST_SECURITY, GET_PERMS_AS_ACL, GET_PERMS_DEFAULT, PROP_CERTIFICATE, PROP_DESCRIPTION, PROP_DOMAIN, PROP_FULL_NAME, PROP_IS_LOCKSMITH, PROP_LDAP_SERVER, PROP_NAME, PROP_NISPLUS_SERVER, PROP_PARENT_URL, PROP_PASSWORD, PROP_QUAL_NAME, PROP_TYPE, PROP_URL, REQUIRE_LOGIN, REQUIRE_LOGIN_SUPPORTED

Method Summary

boolean	isActive() Check to see if the EJB JAR is active.
void	shutdown(boolean restart) Shut down the JAR and all its beans for the current server session.

Methods implemented from interface com.sssw.rts.adminapi.AgiAdmElement

getPermissions, getServerURL, getURL, getVariables, isAuthorized, setPermissions

Methods implemented from interface com.sssw.rts.adminapi.AgiAdmElementBase

delete, getName, getType

Methods implemented from interface com.sssw.rts.adminapi.AgiAdmPropertyBag

getProperties, getProperty, setProperties, setProperty

Methods implemented from interface com.sssw.rts.adminapi.AgiAdmChanges

cancelChanges, saveChanges

Field Detail

EJB_JAR

public static final String EJB_JAR

The "EJB JAR" design element type.

PROP_EJB_HOMES

public static final String PROP_EJB_HOMES

The list of EJB Homes of the EJBs that the EJB JAR contains. Value type: String array.

This property is read-only.

PROP_EJB_JNDI_NAMES

public static final String PROP_EJB_JNDI_NAMES

The list of EJB JNDI names of the EJBs that the EJB JAR contains. Value type: String array.

This property is read-only.

PROP_ENABLED

public static final String PROP_ENABLED

This property allows the caller to manage the "is enabled" status of the EJB JAR. It's both gettable and settable. Value type: Boolean.

If a JAR is disabled, none of the EJBs in the JAR are available. Disabling a JAR stops any running EJBs in the JAR. A disabled JAR remains disabled until it is explicitly enabled.

For example:

 // Get the current status
 Boolean enabled = (Boolean)ejbJar.getProperty(AgiAdmEjbJar.PROP_ENABLED);
 // Disable the JAR
 ejbJar.setProperty(AgiAdmEjbJar.PROP_ENABLED, new Boolean(false));
 ejbJar.saveChanges();
 // Enable the JAR
 ejbJar.setProperty(AgiAdmEjbJar.PROP_ENABLED, new Boolean(true));
 ejbJar.saveChanges();
 

Method Detail

isActive

public boolean isActive()
                 throws AgoUnrecoverableSystemException,
                        AgoSecurityException

Check to see if the EJB JAR is active.

Returns:

true if the EJB Jar is actively running in the server EJB Container;

Usage:

This method checks the run-time behavior of the EJB Jar.

Example:

 boolean active = jar.isActive();
 

shutdown

public void shutdown(boolean restart)
              throws AgoUnrecoverableSystemException,
                     AgoSecurityException

Shut down the JAR and all its beans for the current server session.

Parameters:

restart - if true, the EJB JAR is restarted, otherwise it's just shut down

Usage:

When a JAR is shut down, none of the EJBs in the JAR are available. When the server is restarted, enabled JARs that had been shut down in the previous server session are again available.

Example:

 jar.shutdown(false);