ATG Web Services and Integration Framework Guide
.
Documentation Home
Feedback
Highlighting
Prev
Up
Next
Parsing Output
Contents
Search
Creating and Using Web Services in the ATG Platform
Creating Custom Web Services
Overview of ATG Web Services Support
JAX-RPC
Automatic Generation of Web Services
Session and Security Support
Limitations
Web Service Creation Wizard
Using the Wizard
Naming Restrictions
Anatomy of a Web Service
Service Endpoint Interface and Implementation Class
WSDL Document
web.xml File
JAX-RPC Deployment Descriptor and Mapping Files
Runtime Classes
JSR 109 Compliant EAR File
Web Service Security
Security Components
Creating and Editing Security Configurations
Deploying Web Services
Managing Web Services
Registering Services
Creating JMS Web Services
Using the JMS Message Web Service Wizard
Structure of a JMS Web Service
Patch Bay Configuration
Creating Repository Web Services
Using the Repository Web Service Wizard
Repository Web Service Limitations
Modifying Repository Web Services
RepositoryService Class
Repository to XML Data Binding
Mapping Files and XML Schemas
Mapping Files
Managing Mapping Files for Repository Item Descriptors
XML Schemas
Managing Schemas and Mapping Files
PropertyElementNameSeparator
Item References
Repository Operations
Getting Repository Items
Adding Repository Items
Updating Repository Items
Removing Repository Items
Accessing ATG Web Services from Java Clients
About ATG Web Services
Security
Transactions
Sharing Sessions
RepositoryItems
Before You Begin
Writing a CookieContainer Class
Calling ATG Web Services
Creating a Call Using a Client Stub (Static)
Creating a Call Using the Dynamic Invocation Interface (Dynamic)
Creating a Serializer and Deserializer
Creating a Mapping File
Generating an XML Schema
Accessing ATG Web Services from .NET Clients
About Web Services in the ATG Platform
Security
Transactions
Session Sharing
Client Stubs
Web Services that Access RepositoryItems
Before You Begin
Installing ATGWS.dll
Calling ATG Web Services
Accessing an ATG Web Service
Accessing a Custom ATG Web Service
Sample Web Service Calls
Using the Atg.DotNet.WebService API to Serialize and Deserialize RepositoryItems
RepositoryItem Class
Property Class
RepositoryItemRef Class
Complex Type Class
NoSuchPropertyException Class
RepositoryItemSerializer Class
RepositoryItemSerializationException Class
Integration Framework
Integration Repository
Architecture
Integration Approaches
Remote Only
Remote then Local
Local then Remote
Local Only
Setting Up an Integration Repository
Defining an Integration Repository
Integration Repository APIs
IntegrationRepository
IntegrationRepositoryItemDescriptor
IntegrationRepositoryItem
ChangedPropertyBean
atg.repository.databinding.MappingRepositoryItem
IntegrationRepositoryView
Command Operations
executeQuery
getItem
updateItem
addItem
removeItem
Mapping
Persistent Caching
Cleaning up the Persistent Cache
Configuration Examples
Configuring the Remote-Only Model
Configuring the Remote-then-Local Model
Configuring the Local-then-Remote Model
Integration Repository Definition File
integration-repository-template tag
header tag
item-descriptor tag
item-descriptor Child Tags
integration-repository Document Type Definition
Remote Procedure Calls
RPC API Architecture
Command Interface
CommandHandler Interface
CommandResult Class
Implementing the RPC API
Exception Handling
Executing Commands in Pages
ATG Platform REST Web Services
Getting Started
Starting the ATG Server with the REST Module
Setting the Default ACL for REST Security
Configuring the Web Services
Creating Simple Applications
Client Libraries
Java Client Library
Creating Requests
Creating a RestSession Object
Logging in and Logging Out
Accessing Data from the Server
Creating a Raw REST Request
Handling Results
ActionScript Client Library
atg.rest.client.RestComponentHelper
atg.rest.client.RestRepositoryHelper
Working with Components
A Note about Output Format
A Note about Nucleus Component Security
Getting Component Data
Getting and Setting Property Values
Calling Methods
Passing Parameters to Methods
Calling Handler Methods
Passing Parameters to Form Handlers
Calling Methods with ActionScript
Working with Repository Items
About Output Format
About Repository Security
Getting Repository Items
Repository IDs
Adding Repository Items
Deleting Repository Items
Getting Repository Item Properties
Setting Repository Item Properties
Performing Queries for Repository Items
Input and Output Formats
Parsing Output
JSON Output
XML Output
Formatting Input
Formatting Input with ActionScript
Property Filtering
Property Aliasing
Security
Global Security
Component Security
Property and Method Security
Securing Groups of Components
Control Parameters
HTTP Status Codes
Error Messages
Index