|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.servlet.jsp.tagext.TagSupport
com.alarmpoint.integrations.infrastructure.agent.service.tag.IntegrationAgentServiceTag
public class IntegrationAgentServiceTag
A JSP custom tag to make an external service request to the integration agent To declare the tag library use the JSP taglib directive.
<%@ taglib uri="http://alarmpoint.com/alarmpoint/4.0#integrationagentservice" prefix="apia" %>Tag Reference: request
Attribute | Description |
action | An action provided by the integration service. |
service | The integration service that will perform the action provided by an integration agent. |
domain | The Event Domain associated with the integration service. |
company | The Company Name associated with the integration service. Defaults to Default Company |
Attribute | Description |
name | name of the parameter |
type | the data type associated with the parameter |
<apia:request action="echo" service="test_service_1" domain="default" company="Default Company"> <apia:argument name="String" type="string">This is a string.</apia:argument> <apia:argument name="Integer" type="integer">100</apia:argument> <apia:argument name="Float" type="float">11.11</apia:argument> <apia:argument name="Boolean" type="boolean">true</apia:argument> </apia:request>
Field Summary |
---|
Fields inherited from class javax.servlet.jsp.tagext.TagSupport |
---|
id, pageContext |
Fields inherited from interface javax.servlet.jsp.tagext.IterationTag |
---|
EVAL_BODY_AGAIN |
Fields inherited from interface javax.servlet.jsp.tagext.Tag |
---|
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE |
Constructor Summary | |
---|---|
IntegrationAgentServiceTag()
Creates a new instance of SubscriptionIntegrationServiceTag |
Method Summary | |
---|---|
protected java.lang.String |
convertProperty(java.lang.String propertyName)
Converts first character of property to UpperCase |
int |
doEndTag()
Using the tag data, pass the information to the Integration Agent and process the response |
int |
doStartTag()
Start processing the tag |
java.util.Map<java.lang.String,java.lang.Object> |
getArguments()
Retrieve a map of names and values to be provided as parameters to the integration service as part of the action. |
protected java.lang.Object |
getValue(java.lang.Object obj,
java.lang.String propertyName)
Reflective call to retrieve the values from the object stored in the returned list |
void |
setAction(java.lang.String action)
An action provided by the integration service. |
void |
setArguments(java.util.Map<java.lang.String,java.lang.Object> arguments)
Set a map of names and values to be provided as parameters to the integration service as part of the action. |
void |
setCompany(java.lang.String company)
The Company Name associated with the integration service. |
void |
setDomain(java.lang.String domain)
The Event Domain associated with the integration service. |
void |
setService(java.lang.String service)
The integration service that will perform the action provided by an integration agent. |
Methods inherited from class javax.servlet.jsp.tagext.TagSupport |
---|
doAfterBody, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setPageContext, setParent, setValue |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public IntegrationAgentServiceTag()
Method Detail |
---|
public int doStartTag()
doStartTag
in interface javax.servlet.jsp.tagext.Tag
doStartTag
in class javax.servlet.jsp.tagext.TagSupport
public int doEndTag() throws javax.servlet.jsp.JspTagException
doEndTag
in interface javax.servlet.jsp.tagext.Tag
doEndTag
in class javax.servlet.jsp.tagext.TagSupport
javax.servlet.jsp.JspTagException
- if there are any issue processing the requestprotected java.lang.Object getValue(java.lang.Object obj, java.lang.String propertyName) throws javax.servlet.jsp.JspTagException
obj
- instance of the object to querypropertyName
- name of the property to retrieve
javax.servlet.jsp.JspTagException
protected java.lang.String convertProperty(java.lang.String propertyName)
propertyName
- name of the property
public void setAction(java.lang.String action)
action
- String identifying the name of the method to call in the IA scriptpublic void setService(java.lang.String service)
service
- integration servicepublic void setDomain(java.lang.String domain)
domain
- event domainpublic void setCompany(java.lang.String company)
company
- company namepublic void setArguments(java.util.Map<java.lang.String,java.lang.Object> arguments)
arguments
- map of names and valuespublic java.util.Map<java.lang.String,java.lang.Object> getArguments()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |