|
Hyperic HQ Plugin API v. 4.4.0.2 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.hyperic.hq.ui.action.resource.common.monitor.visibility.InventoryHelper
public abstract class InventoryHelper
A class that provides utility methods for common monitoring
tasks.
Typical usage: an action class uses the getHelper
factory method to obtain an InventoryHelper
specific
to the entity type of a particular resource.
Field Summary | |
---|---|
protected AppdefEntityID |
entityId
|
protected org.apache.commons.logging.Log |
log
|
Constructor Summary | |
---|---|
protected |
InventoryHelper(AppdefEntityID entityId)
|
Method Summary | |
---|---|
abstract java.util.Map |
getChildCounts(javax.servlet.http.HttpServletRequest request,
javax.servlet.ServletContext ctx,
AppdefResourceValue resource)
Get from the Bizapp the numbers of children of the given resource. |
abstract AppdefResourceType |
getChildResourceType(javax.servlet.http.HttpServletRequest req,
javax.servlet.ServletContext ctx,
AppdefEntityTypeID atid)
Get a child resource type from the Bizapp. |
abstract java.util.List |
getChildResourceTypes(javax.servlet.http.HttpServletRequest request,
javax.servlet.ServletContext ctx,
AppdefResourceValue resource)
Get the set of child resource types representing a resource's child resources. |
static InventoryHelper |
getHelper(AppdefEntityID entityId)
Return a subclass of InventoryHelper specific to
the entity type of a particular resource. |
java.lang.Integer |
getSelectedChildId(javax.servlet.http.HttpServletRequest request,
java.util.List childTypes,
java.util.Map childCounts)
Retrieve the id of the selected child resource type from the request. |
java.lang.Integer |
getSelectedChildId(javax.servlet.http.HttpServletRequest request,
java.util.List childTypes,
java.util.Map childCounts,
boolean defaultOverride)
Retrieve the id of the selected child resource type from the request. |
AppdefResourceTypeValue |
getSelectedChildType(javax.servlet.http.HttpServletRequest request,
java.util.List childTypes,
java.util.Map childCounts,
java.lang.Integer selectedId)
Retrieve the AppdefResourceTypeValue representing
the currently selected child resource type (or, if the
isPerformance flag is not set, the default
child resource type, if none is currently selected). |
boolean |
isResourceConfigured(javax.servlet.http.HttpServletRequest request,
javax.servlet.ServletContext ctx,
boolean setError)
|
boolean |
selectDefaultSubtab()
Return a boolean indicating whether or not performance pages should select the default subtab when none is selected. |
boolean |
showPerformanceSubtabs()
Return a boolean indicating whether or not performance pages should show child type subtabs. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected org.apache.commons.logging.Log log
protected AppdefEntityID entityId
Constructor Detail |
---|
protected InventoryHelper(AppdefEntityID entityId)
Method Detail |
---|
public static InventoryHelper getHelper(AppdefEntityID entityId)
InventoryHelper
specific to
the entity type of a particular resource.
public abstract java.util.List getChildResourceTypes(javax.servlet.http.HttpServletRequest request, javax.servlet.ServletContext ctx, AppdefResourceValue resource) throws java.lang.Exception
java.lang.Exception
public abstract AppdefResourceType getChildResourceType(javax.servlet.http.HttpServletRequest req, javax.servlet.ServletContext ctx, AppdefEntityTypeID atid) throws java.lang.Exception
id
- the id of the child resource type
java.lang.Exception
public abstract java.util.Map getChildCounts(javax.servlet.http.HttpServletRequest request, javax.servlet.ServletContext ctx, AppdefResourceValue resource) throws java.lang.Exception
Map
of counts keyed by
child resource type.
resource
- the appdef resource whose children we are
counting
java.lang.Exception
public java.lang.Integer getSelectedChildId(javax.servlet.http.HttpServletRequest request, java.util.List childTypes, java.util.Map childCounts, boolean defaultOverride)
selectDefaultSubtab
allows.
childTypes
- the complete List of child resource types for
this entity typechildCounts
- the Map of child resource counts keyed by
resource typedefaultOverride
- whether or not to override
selectDefaultSubtab
public java.lang.Integer getSelectedChildId(javax.servlet.http.HttpServletRequest request, java.util.List childTypes, java.util.Map childCounts)
selectDefaultSubtab
allows.
childTypes
- the complete List of child resource types for
this entity typechildCounts
- the Map of child resource counts keyed by
resource typepublic AppdefResourceTypeValue getSelectedChildType(javax.servlet.http.HttpServletRequest request, java.util.List childTypes, java.util.Map childCounts, java.lang.Integer selectedId)
AppdefResourceTypeValue
representing
the currently selected child resource type (or, if the
isPerformance
flag is not set, the default
child resource type, if none is currently selected).
childTypes
- the complete List of child resource types for
this entity typechildCounts
- the Map of child resource counts keyed by
resource typeisPerformance
- a Boolean indicating whether or not we are
currently displaying a performance pagepublic boolean showPerformanceSubtabs()
public boolean selectDefaultSubtab()
public boolean isResourceConfigured(javax.servlet.http.HttpServletRequest request, javax.servlet.ServletContext ctx, boolean setError) throws javax.servlet.ServletException, AppdefEntityNotFoundException, SessionNotFoundException, SessionTimeoutException, PermissionException, EncodingException, java.rmi.RemoteException
javax.servlet.ServletException
AppdefEntityNotFoundException
SessionNotFoundException
SessionTimeoutException
PermissionException
EncodingException
java.rmi.RemoteException
|
Hyperic HQ Plugin API v. 4.4.0.2 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |