Appendix B.  ATG Servlet Beans

This appendix provides detailed reference entries for the servlet beans that are included with ATG Adaptive Scenario Engine. It begins with a list of servlet beans grouped by functional area, and continues with the reference entries in alphabetical order.

Note that additional servlet beans are included with other ATG solutions. Your application can also use custom servlet beans written by programmers at your site.

There are several types of servlet beans included with ATG Adaptive Scenario Engine:

Standard Servlet Beans

The following table provides a list of the standard servlet beans, and summarizes what they do.

ClassName

atg.droplet.BeanProperty

Component

/atg/dynamo/droplet/BeanProperty

Function

Sets any property value by dynamically specifying the property and value to update

ClassName

atg.droplet.Cache

Component

/atg/dynamo/droplet/Cache

Function

Caches content that changes infrequently

ClassName

atg.droplet.Compare

Component

/atg/dynamo/droplet/Compare

Function

Displays one of a set of possible outputs, depending on the relative value of its two input parameters

 

ClassName

atg.droplet.CurrencyConversionFormatter

Component

/atg/dynamo/droplet/CurrencyConversionFormatter 

Function

Displays a numeric value as a currency amount, and converts a value from one currency to another, formatting it based on the locale

ClassName

atg.droplet.CurrencyFormatter

Component

/atg/dynamo/droplet/CurrencyFormatter

Function

Displays a numeric value as a currency amount, formatting it based on the locale

 

ClassName

atg.droplet.ErrorMessageForEach

Component

/atg/dynamo/droplet/ErrorMessageForEach
/atg/userprofiling/ProfileErrorMessageForEach
/atg/demo/QuincyFunds/FormHandlers/RepositoryErrorMessageForEach

Function

Displays error messages that occur during a form submission

 

ClassName

atg.droplet.For

Component

/atg/dynamo/droplet/For

Function

Displays a single output the number of times specified

 

ClassName

atg.droplet.ForEach

Component

/atg/dynamo/droplet/ForEach

Function

Displays each element of an array

 

ClassName

atg.droplet.Format

Component

/atg/dynamo/droplet/Format

Function

Displays one or more text values, formatting them based on locale

 

ClassName

atg.droplet.IsEmpty

Component

/atg/dynamo/droplet/IsEmpty

Function

Displays one of two possible outputs, depending on whether its input parameter is empty

 

ClassName

atg.droplet.IsNull

Component

/atg/dynamo/droplet/IsNull

Function

Displays one of two possible outputs, depending on whether its input parameter is null

 

ClassName

atg.droplet.ProtocolChange

Component

/atg/dynamo/droplet/ProtocolChange

Function

Enables switching between http and https protocols

 

ClassName

atg.droplet.Range

Component

/atg/dynamo/droplet/Range

Function

Displays a subset of the elements of an array

 

ClassName

atg.droplet.Redirect

Component

/atg/dynamo/droplet/Redirect

Function

Redirects the user to the specified page

ClassName

atg.droplet.Switch

Component

/atg/dynamo/droplet/Switch

Function

Displays one of a set of possible outputs, depending on the value of its input parameter

 

ClassName

atg.droplet.TableForEach

Component

/atg/dynamo/droplet/TableForEach

Function

Displays each element of an array, arranging the output in a two-dimensional format

 

ClassName

atg.droplet.TableRange

Component

/atg/dynamo/droplet/TableRange

Function

Displays a subset of the elements of an array, arranging the output in a two-dimensional format

Database and Repository Access Servlet Beans

The following table provides a list of the servlet beans for accessing data stored in a database or a repository.

ClassName

atg.repository.seo.ItemLink

Component

Function

Takes a repository item as input and generates either a static or dynamic URL, depending on whether the page it is on is being viewed by a human visitor or a Web spider.

ClassName

atg.repository.servlet.ItemLookupDroplet

Component

/atg/dynamo/droplet/ItemLookupDroplet

Function

Looks up an item in one or more repositories, based on the item’s ID, and renders the item on the page

 

ClassName

atg.repository.servlet.NavHistoryCollector

Component

Function

Tracks each page that a user visits and makes it easy for that user to backtrack and return to pages he or she has already visited

ClassName

atg.service.pipeline.servlet.PipelineChainInvocation

Component

/atg/dynamo/droplet/PipelineChainInvocation

Function

Initiates a pipeline thread

ClassName

atg.repository.servlet.PossibleValues

Component

/atg/dynamo/droplet/PossibleValues

Function

Returns a list of repository items of the specified item type

 

ClassName

atg.rview.RelationalViewDroplet

Component

/atg/dynamo/service/jdbc/RelationalViewDroplet

Function

Specifies a RelationalView and subview, executes a query, and then passes the results of that query to another servlet bean (such as ForEach) for display

 

ClassName

atg.repository.servlet.RQLQueryForEach

Component

/atg/dynamo/droplet/RQLQueryForEach

Function

Constructs an RQL query and renders its output parameter once for each element returned by the query

ClassName

atg.repository.servlet.RQLQueryRange

Component

/atg/dynamo/droplet/RQLQueryRange

Function

Constructs an RQL query of a SQL database and renders its output parameter for a selected subset of the elements returned by the query

ClassName

atg.droplet.sql.SQLQueryForEach

Component

/atg/dynamo/droplet/SQLQueryForEach

Function

Constructs a query of a SQL database and renders its output parameter once for each row returned by the database query

ClassName

atg.droplet.sql.SQLQueryRange

Component

/atg/dynamo/droplet/SQLQueryRange

Function

Constructs a query of a SQL database and renders its output parameter once for each of a specified range of the rows returned by the database query

XML Servlet Beans

The following table provides a list of the servlet beans for use with XML documents.

ClassName

atg.droplet.xml.NodeForEach

Component

/atg/dynamo/droplet/xml/NodeForEach

Function

Given a DOM node, selects all nodes that match a specified pattern and iterates over each selected node

 

ClassName

atg.droplet.xml.NodeMatch

Component

/atg/dynamo/droplet/xml/NodeMatch

Function

Given a DOM node, selects the next node that matches a specified pattern

 

ClassName

atg.droplet.xml.DOM

Component

/atg/dynamo/droplet/xml/XMLToDOM

Function

Parses an XML document and transforms it into a DOM document, making the document’s nodes and attributes available as objects and object properties

 

ClassName

atg.droplet.xml.XMLTransform

Component

/atg/dynamo/droplet/xml/XMLTransform

Function

Given an XML document and an XSLT or JSP template, transforms and outputs the XML document, with the formatting provided by the template

Transaction Servlet Beans

The following table provides a list of the servlet beans for transaction demarcation.

ClassName

atg.dtm.EndTransactionDroplet

Component

/atg/dynamo/transaction/droplet/EndTransaction

Function

Commits or rolls back the current transaction

 

ClassName

atg.dtm.TransactionDroplet

Component

/atg/dynamo/transaction/droplet/Transaction

Function

Marks the bounds of a transaction within a JSP

Personalization Servlet Beans

The following table provides a list of the servlet beans for use with user profiles.

ClassName

atg.markers.userprofiling.droplet.AddMarkerToProfile

Component

/atg/markers/userprofiling/droplet/AddMarkerToProfileDroplet

Function

Add a profile marker to a profile

ClassName

atg.markers.userprofiling.droplet.ProfileHasLastMarker

Component

/atg/markers/userprofiling/droplet/ProfileHasLastMarkerDroplet

Function

Locates the last profile marker added to a profile

ClassName

atg.markers.userprofiling.droplet.ProfileHasLastMarkerWithKey

Component

/atg/markers/userprofiling/droplet/ProfileHasLastMarkerWithKey
Droplet

Function

Locates the last profile marker with a particular key that was added to a profile

ClassName

atg.markers.userprofiling.droplet.ProfileHasMarker

Component

/atg/markers/userprofiling/droplet/ProfileHasMarkerDroplet

Function

Determines whether a profile has a profile marker

ClassName

atg.markers.userprofiling.droplet.RemoveAllMarkersFromProfile

Component

/atg/markers/userprofiling/droplet/RemoveAllMarkersFromProfile
Droplet

Function

Removes all profile markers from a profile

ClassName

atg.markers.userprofiling.droplet.RemoveMarkersFromProfile

Component

/atg/markers/userprofiling/droplet/RemoveMarkersFromProfile
Droplet

Function

Removes a profile marker from a profile

ClassName

atg.service.collections.filter.droplet.CollectionFilter

Component

/atg/collections/filter/droplet/StartEndDateFilterDroplet

Function

Filters objects in a collection

ClassName

atg.userprofiling.GetDirectoryPrincipal

Component

/atg/userprofiling/GetDirectoryPrincipal

Function

Returns the DirectoryPrincipal for a specified type and ID

ClassName

atg.userprofiling.HasEffectivePrincipal

Component

/atg/userprofiling/HasEffectivePrincipal

Function

Fires a content event if a user has the appropriate Principal (identity)

ClassName

atg.userprofiling.PageEventTriggerDroplet

Component

/atg/userprofiling/SendPageEvent

Function

Sends page viewed events for the current page being viewed

ClassName

atg.targeting.RuleBasedRepositoryItemGroupFilter

Component

/atg/targeting/RuleBasedRepositoryItemGroupFilter

Function

Renders a collection of RepositoryItems that belong to the specified RuleBasedRepositoryItemGroup

ClassName

atg.targeting.RepositoryLookup

Component

/atg/targeting/RepositoryLookup

Function

Looks up an item in a specific repository, based on the item’s ID, and renders the item on the page

ClassName

atg.targeting.TargetingArray

Component

/atg/targeting/TargetingArray

Function

Performs a targeting operation and then passes the results to another servlet bean for display

ClassName

atg.targeting.TargetingFirst

Component

/atg/targeting/TargetingFirst

Function

Performs a targeting operation and displays the first n items returned by the targeter, where n is a number you specify

ClassName

atg.targeting.TargetingForEach

Component

/atg/targeting/TargetingForEach

Function

Performs a targeting operation and displays all of the items returned by the targeter

ClassName

atg.targeting.TargetingRandom

Component

/atg/targeting/TargetingRandom

Function

Performs a targeting operation and randomly selects and displays n items returned by the targeter, where n is a number you specify

ClassName

atg.targeting.TargetingRange

Component

/atg/targeting/TargetingRange

Function

Performs a targeting operation and displays a subset of the items returned by the targeter, specified as a range

ClassName

atg.workflow.servlet.WorkflowInstanceQueryDroplet

Component

Function

Returns information about a specified set of workflow instances

ClassName

atg.workflow.servlet.WorkflowTaskQueryDroplet

Component

Function

Returns information about a specified set of workflow tasks

Business Process Tracking Servlet Beans

The following table provides a list of the servlet beans that work with business process tracking.

ClassName

atg.markers.bp.droplet.AddBusinessProcessStage

Component

/atg/markers/bp/droplet/AddBusinessProcessStageDroplet

Function

Adds a marker when a business object reaches a new business process stage

ClassName

atg.markers.bp.droplet.HasBusinessProcessStage

Component

/atg/markers/bp/droplet/HasBusinessProcessStageDroplet

Function

Tests whether a business object has reached a specified business process stage

ClassName

atg.markers.bp.droplet.MostRecentBusinessProcessStage

Component

/atg/markers/bp/droplet/MostRecentBusinessProcessStageDroplet

Function

Tests whether the business process stage most recently reached by a business object matches the specified stage

ClassName

atg.markers.bp.droplet.RemoveBusinessProcessStage

Component

/atg/markers/bp/droplet/RemoveBusinessProcessStageDroplet

Function

Removes a specified business process stage

 
loading table of contents...