|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Description
Web Script Description
Nested Class Summary | |
---|---|
static class |
Description.FormatStyle
Enumeration of ways to specify format |
static class |
Description.Lifecycle
Enumeration of lifecycle which indicates the status of this web script |
static class |
Description.RequiredAuthentication
Enumeration of "required" Authentication level |
static interface |
Description.RequiredCache
Caching requirements |
static class |
Description.RequiredTransaction
Enumeration of "required" Transaction level |
static interface |
Description.RequiredTransactionParameters
Transaction Requirements |
static class |
Description.TransactionCapability
Enumeration of transaction capability |
Method Summary | |
---|---|
String |
getDefaultFormat()
Gets the default response format Note: the default response format is the first listed in the service description document |
InputStream |
getDescDocument()
Gets the description xml document for this web script |
String |
getDescPath()
Gets the path of the description xml document for this web script |
String |
getDescription()
Gets the description of this service |
Map<String,Serializable> |
getExtensions()
Gets web script specific extensions |
Set<String> |
getFamilys()
Gets the family(s) of this service in the order that they are defined |
Description.FormatStyle |
getFormatStyle()
Gets the style of Format discriminator supported by this web script |
String |
getId()
Gets the id of this service |
String |
getKind()
Gets the kind of service. |
Description.Lifecycle |
getLifecycle()
Get the lifecycle |
String |
getMethod()
Gets the HTTP method this service is bound to |
NegotiatedFormat[] |
getNegotiatedFormats()
Gets the formats available for negotiation |
Path |
getPackage()
Gets the package (Path version of getScriptPath) |
Description.RequiredAuthentication |
getRequiredAuthentication()
Gets the required authentication level for execution of this service |
Description.RequiredCache |
getRequiredCache()
Gets the required level of caching |
Description.RequiredTransaction |
getRequiredTransaction()
Gets the required transaction level |
Description.RequiredTransactionParameters |
getRequiredTransactionParameters()
Gets the transaction parameters |
String |
getRunAs()
Gets the ID of the user that the service should be run as or null if the service is to be run as the
authenticated user. |
String |
getScriptPath()
Gets the path within the store of this web script |
String |
getShortName()
Gets the short name of this service |
String |
getStorePath()
Gets the root path of the store of this web script |
String[] |
getURIs()
Gets the URIs this service supports |
Method Detail |
---|
String getStorePath()
String getScriptPath()
Path getPackage()
String getDescPath()
InputStream getDescDocument() throws IOException
IOException
String getId()
String getKind()
String getShortName()
String getDescription()
Set<String> getFamilys()
Description.RequiredAuthentication getRequiredAuthentication()
String getRunAs()
null
if the service is to be run as the
authenticated user.
null
if not applicableDescription.RequiredTransaction getRequiredTransaction()
Description.RequiredTransactionParameters getRequiredTransactionParameters()
Description.RequiredCache getRequiredCache()
String getMethod()
String[] getURIs()
Description.FormatStyle getFormatStyle()
String getDefaultFormat()
NegotiatedFormat[] getNegotiatedFormats()
Map<String,Serializable> getExtensions()
Description.Lifecycle getLifecycle()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |