The GetRepositoryItem Web service retrieves an item with the given repository ID and item type from the given repository. The item is returned in XML format. The Web service method calls directly through to the getRepositoryItem method of the atg.repository.RepositoryServices class, which handles all logic, error checking, and result transformation.

Web Service Implementation

Web Service URL

http://hostname:port/repository/generic
/getRepositoryItem/getRepositoryItem

Web Service Class Name

webservice.GetRepositoryItemsEIImpl

Nucleus Component

/atg/repository/RepositoryServices

Method Name

getRepositoryItem

Input Parameters

String pRepositoryPath
the path of the repository component from which to retrieve the item

String pItemDescriptorName
the item type of the item to retrieve

String pRepositoryId
the repository ID of the repository item to retrieve

Output

String
the found RepositoryItem in XML format, or null if no item with that repository ID exists

Exceptions

atg.repository.RepositoryException if a repository error occurs

atg.repository.xml.GetException if an error occurs translating the item into XML

GetRepositoryItem Exceptions

Exceptions generated by the GetRepositoryItem Web service may occur for the following reasons:

RepositoryException

GetException

Web Service Generation

The following parameters are used to generate this Web service, using the WebServiceGeneratorImpl class:

Parameter

Value

NucleusPath

/atg/repository/RepositoryServices

MethodName

getRepositoryItem

EarFileName

repositoryWebServices.ear

AppName

RepositoryWebServices

AppDescription

A collection of Web services used to make repository calls

ServletName

getRepositoryItem

ServletDisplayName

GetRepositoryItem

ServletDescription

When called, gets a repository using the given arguments

URLPattern

GetRepositoryItem

WebURI

generic.war

ContextPath

repository/generic

WebAppDisplayName

RepositoryServices

WebAppDescription

A collection of generic repository Web services, where the user must provide information about which repository is being acted upon

Host

null (will be dynamic)

Port

null (will be dynamic)

ParameterNames

pRepositoryPath, pItemDescriptorName, pRepositoryId

UseSession

true

Web Service Security

By default, the GetRepositoryItem Web service uses a security policy that allows access only by Administrators. You are free to change this to suit your needs, depending on how you expect to use this service.


Copyright © 1997, 2013 Oracle and/or its affiliates. All rights reserved. Legal Notices