org.apache.juddi.api.impl.rest

Class UDDIInquiryJAXRS

java.lang.Object

org.apache.juddi.api.impl.rest.UDDIInquiryJAXRS

@Path(value="/")
 @Produces(value={"application/xml","application/json","text/html"})
public class UDDIInquiryJAXRS
extends Object

UDDI Inquiry functions via a JAX-RS REST API. It's basically a wrapper for the REST fans to access UDDI from a URL pattern This class will ONLY deploy using the Apache CXF WS stack for REST (JAX-RS)

Author:

Alex O'Ree

Constructor Summary

Constructors

Constructor and Description
UDDIInquiryJAXRS()

Method Summary

Modifier and Type	Method and Description
UriContainer	geEndpointsByServiceJSON(String id) Returns the binding details of a given entity in JSON
BindingTemplate	getBindingDetailJSON(String id) Returns the binding details of a given entity in JSON
BindingTemplate	getBindingDetailXML(String id) Returns the binding details of a given entity in XML
BusinessEntity	getBusinessDetailJSON(String id) Returns the details of a business entity in JSON
BusinessEntity	getBusinessDetailXML(String id) Returns the details of a business entity in XML
KeyBag	getBusinessListJSON() Returns the business keys of the first 100 registered businesses in JSON
KeyBag	getBusinessListXML() Returns the business keys of the first 100 registered businesses in XML
BusinessList	getBusinessSearchJSON(String name, String lang, String findQualifiers, Integer maxrows, Integer offset) Returns the search results for registered businesses in JSON
BusinessList	getBusinessSearchXML(String name, String lang, String findQualifiers, Integer maxrows, Integer offset) Returns the search results for registered businesses in XML
Object	getDetailJSON(String serviceKey, String businessKey, String tModelKey, String bindingKey) This method implements the UDDIv3 spec for HTTP GET Inquiry services Returns the details of a UDDI entity in JSON, use query parameters serviceKey,businessKey,tModelKey, or bindingKey
Object	getDetailXML(String serviceKey, String businessKey, String tModelKey, String bindingKey) This method implements the UDDIv3 spec for HTTP GET Inquiry services.
UriContainer	getEndpointsByServiceXML(String id) Returns the binding details of a given entity in XML
OperationalInfo	getOpInfoJSON(String id) Returns the operational details of a given entity in JSON
OperationalInfo	getOpInfoXML(String id) Returns the operational details of a given entity in XML
BusinessService	getServiceDetailJSON(String id) Returns the details of a service entity in JSON
BusinessService	getServiceDetailXML(String id) Returns the details of a service entity in XML
KeyBag	getServiceListJSON() Returns the Service keys of the first 100 registered services in JSON
KeyBag	getServiceListXML() Returns the Service keys of the first 100 registered services in XML
ServiceList	getServiceSearchJSON(String name, String lang, String findQualifiers, Integer maxrows, Integer offset) Returns the search results for registered services in JSON
ServiceList	getServiceSearchXML(String name, String lang, String findQualifiers, Integer maxrows, Integer offset) Returns the search results for registered services in XML
TModel	getTModelDetailJSON(String id) Returns the details of a tModel entity in JSON
TModel	getTModelDetailXML(String id) Returns the details of a tModel entity in XML
KeyBag	getTModelListJSON() Returns the tModel keys of the first 100 registered services in JSON
KeyBag	getTModelListXML() Returns the tModel keys of the first 100 registered services in XML
TModelList	getTModelSearchJSON(String name, String lang, String findQualifiers, Integer maxrows, Integer offset) Returns the search results for registered tModel in JSON
TModelList	getTModelSearchXML(String name, String lang, String findQualifiers, Integer maxrows, Integer offset) Returns the search results for registered tModel in XML

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UDDIInquiryJAXRS

public UDDIInquiryJAXRS()

Method Detail

getBusinessDetailJSON

@GET
 @Path(value="/JSON/businessKey/{id}")
 @Produces(value="application/json")
public BusinessEntity getBusinessDetailJSON(@PathParam(value="id")
                                                                                                                                String id)
                                                                                                                         throws javax.ws.rs.WebApplicationException

Returns the details of a business entity in JSON

Parameters:

id -

Returns:

json

Throws:

javax.ws.rs.WebApplicationException

getBusinessDetailXML

@GET
 @Path(value="/XML/businessKey/{id}")
 @Produces(value="application/xml")
public BusinessEntity getBusinessDetailXML(@PathParam(value="id")
                                                                                                                             String id)
                                                                                                                      throws javax.ws.rs.WebApplicationException

Returns the details of a business entity in XML

Parameters:

id -

Returns:

xml

Throws:

javax.ws.rs.WebApplicationException

getTModelDetailXML

@GET
 @Path(value="/XML/tModelKey/{id}")
 @Produces(value="application/xml")
public TModel getTModelDetailXML(@PathParam(value="id")
                                                                                                                 String id)
                                                                                                          throws javax.ws.rs.WebApplicationException

Returns the details of a tModel entity in XML

Parameters:

id -

Returns:

xml

Throws:

javax.ws.rs.WebApplicationException

getTModelDetailJSON

@GET
 @Path(value="/JSON/tModelKey/{id}")
 @Produces(value="application/json")
public TModel getTModelDetailJSON(@PathParam(value="id")
                                                                                                                    String id)
                                                                                                             throws javax.ws.rs.WebApplicationException

Returns the details of a tModel entity in JSON

Parameters:

id -

Returns:

json

Throws:

javax.ws.rs.WebApplicationException

getServiceDetailJSON

@GET
 @Path(value="/JSON/serviceKey/{id}")
 @Produces(value="application/json")
public BusinessService getServiceDetailJSON(@PathParam(value="id")
                                                                                                                               String id)
                                                                                                                        throws javax.ws.rs.WebApplicationException

Returns the details of a service entity in JSON

Parameters:

id -

Returns:

json

Throws:

javax.ws.rs.WebApplicationException

getDetailJSON

@GET
 @Path(value="/JSON/getDetail")
 @Produces(value="application/json")
public Object getDetailJSON(@QueryParam(value="serviceKey")
                                                                                                         String serviceKey,
                                                                                                         @QueryParam(value="businessKey")
                                                                                                         String businessKey,
                                                                                                         @QueryParam(value="tModelKey")
                                                                                                         String tModelKey,
                                                                                                         @QueryParam(value="bindingKey")
                                                                                                         String bindingKey)
                                                                                                  throws javax.ws.rs.WebApplicationException

This method implements the UDDIv3 spec for HTTP GET Inquiry services Returns the details of a UDDI entity in JSON, use query parameters serviceKey,businessKey,tModelKey, or bindingKey

Parameters:

serviceKey -

businessKey -

tModelKey -

bindingKey -

Returns:

json

Throws:

javax.ws.rs.WebApplicationException

getDetailXML

@GET
 @Path(value="/XML/getDetail")
 @Produces(value="application/xml")
public Object getDetailXML(@QueryParam(value="serviceKey")
                                                                                                      String serviceKey,
                                                                                                      @QueryParam(value="businessKey")
                                                                                                      String businessKey,
                                                                                                      @QueryParam(value="tModelKey")
                                                                                                      String tModelKey,
                                                                                                      @QueryParam(value="bindingKey")
                                                                                                      String bindingKey)
                                                                                               throws javax.ws.rs.WebApplicationException

This method implements the UDDIv3 spec for HTTP GET Inquiry services. Returns the details of a UDDI entity in XML, use query parameters serviceKey,businessKey,tModelKey, or bindingKey

Parameters:

serviceKey -

businessKey -

tModelKey -

bindingKey -

Returns:

xml

Throws:

javax.ws.rs.WebApplicationException

getServiceDetailXML

@GET
 @Path(value="/XML/serviceKey/{id}")
 @Produces(value="application/xml")
public BusinessService getServiceDetailXML(@PathParam(value="id")
                                                                                                                            String id)
                                                                                                                     throws javax.ws.rs.WebApplicationException

Returns the details of a service entity in XML

Parameters:

id -

Returns:

xml

Throws:

javax.ws.rs.WebApplicationException

getOpInfoJSON

@GET
 @Path(value="/JSON/opInfo/{id}")
 @Produces(value="application/json")
public OperationalInfo getOpInfoJSON(@PathParam(value="id")
                                                                                                                    String id)
                                                                                                             throws javax.ws.rs.WebApplicationException

Returns the operational details of a given entity in JSON

Parameters:

id -

Returns:

json

Throws:

javax.ws.rs.WebApplicationException

getOpInfoXML

@GET
 @Path(value="/XML/opInfo/{id}")
 @Produces(value="application/xml")
public OperationalInfo getOpInfoXML(@PathParam(value="id")
                                                                                                                 String id)
                                                                                                          throws javax.ws.rs.WebApplicationException

Returns the operational details of a given entity in XML

Parameters:

id -

Returns:

xml

Throws:

javax.ws.rs.WebApplicationException

getBindingDetailJSON

@GET
 @Path(value="/JSON/bindingKey/{id}")
 @Produces(value="application/json")
public BindingTemplate getBindingDetailJSON(@PathParam(value="id")
                                                                                                                               String id)
                                                                                                                        throws javax.ws.rs.WebApplicationException

Returns the binding details of a given entity in JSON

Parameters:

id -

Returns:

json

Throws:

javax.ws.rs.WebApplicationException

getBindingDetailXML

@GET
 @Path(value="/XML/bindingKey/{id}")
 @Produces(value="application/xml")
public BindingTemplate getBindingDetailXML(@PathParam(value="id")
                                                                                                                            String id)
                                                                                                                     throws javax.ws.rs.WebApplicationException

Returns the binding details of a given entity in XML

Parameters:

id -

Returns:

xml

Throws:

javax.ws.rs.WebApplicationException

geEndpointsByServiceJSON

@GET
 @Path(value="/JSON/endpointsByService/{id}")
 @Produces(value="application/json")
public UriContainer geEndpointsByServiceJSON(@PathParam(value="id")
                                                                                                                                        String id)
                                                                                                                                 throws javax.ws.rs.WebApplicationException

Returns the binding details of a given entity in JSON

Parameters:

id -

Returns:

json

Throws:

javax.ws.rs.WebApplicationException

getEndpointsByServiceXML

@GET
 @Path(value="/XML/endpointsByService/{id}")
 @Produces(value="application/xml")
public UriContainer getEndpointsByServiceXML(@PathParam(value="id")
                                                                                                                                      String id)
                                                                                                                               throws javax.ws.rs.WebApplicationException

Returns the binding details of a given entity in XML

Parameters:

id -

Returns:

xml

Throws:

javax.ws.rs.WebApplicationException

getBusinessListXML

@GET
 @Path(value="/XML/businessList")
 @Produces(value="application/xml")
public KeyBag getBusinessListXML()
                                                                                                        throws javax.ws.rs.WebApplicationException

Returns the business keys of the first 100 registered businesses in XML

Returns:

xml

Throws:

javax.ws.rs.WebApplicationException

getBusinessListJSON

@GET
 @Path(value="/JSON/businessList")
 @Produces(value="application/json")
public KeyBag getBusinessListJSON()
                                                                                                           throws javax.ws.rs.WebApplicationException

Returns the business keys of the first 100 registered businesses in JSON

Returns:

json

Throws:

javax.ws.rs.WebApplicationException

getServiceListXML

@GET
 @Path(value="/XML/serviceList")
 @Produces(value="application/xml")
public KeyBag getServiceListXML()
                                                                                                      throws javax.ws.rs.WebApplicationException

Returns the Service keys of the first 100 registered services in XML

Returns:

xml

Throws:

javax.ws.rs.WebApplicationException

getServiceListJSON

@GET
 @Path(value="/JSON/serviceList")
 @Produces(value="application/json")
public KeyBag getServiceListJSON()
                                                                                                         throws javax.ws.rs.WebApplicationException

Returns the Service keys of the first 100 registered services in JSON

Returns:

json

Throws:

javax.ws.rs.WebApplicationException

getTModelListXML

@GET
 @Path(value="/XML/tModelList")
 @Produces(value="application/xml")
public KeyBag getTModelListXML()
                                                                                                    throws javax.ws.rs.WebApplicationException

Returns the tModel keys of the first 100 registered services in XML

Returns:

xml

Throws:

javax.ws.rs.WebApplicationException

getBusinessSearchXML

@GET
 @Path(value="/XML/businessSearch")
 @Produces(value="application/xml")
public BusinessList getBusinessSearchXML(@QueryParam(value="name")
                                                                                                                         String name,
                                                                                                                         @QueryParam(value="lang")
                                                                                                                         String lang,
                                                                                                                         @QueryParam(value="findQualifiers")
                                                                                                                         String findQualifiers,
                                                                                                                         @QueryParam(value="maxrows")
                                                                                                                         Integer maxrows,
                                                                                                                         @QueryParam(value="offset")
                                                                                                                         Integer offset)
                                                                                                                  throws javax.ws.rs.WebApplicationException

Returns the search results for registered businesses in XML

Parameters:

name -

lang -

findQualifiers -

maxrows -

offset -

Returns:

BusinessList

Throws:

javax.ws.rs.WebApplicationException

getBusinessSearchJSON

@GET
 @Path(value="/JSON/businessSearch")
 @Produces(value="application/json")
public BusinessList getBusinessSearchJSON(@QueryParam(value="name")
                                                                                                                            String name,
                                                                                                                            @QueryParam(value="lang")
                                                                                                                            String lang,
                                                                                                                            @QueryParam(value="findQualifiers")
                                                                                                                            String findQualifiers,
                                                                                                                            @QueryParam(value="maxrows")
                                                                                                                            Integer maxrows,
                                                                                                                            @QueryParam(value="offset")
                                                                                                                            Integer offset)
                                                                                                                     throws javax.ws.rs.WebApplicationException

Returns the search results for registered businesses in JSON

Parameters:

name -

lang -

findQualifiers -

maxrows -

offset -

Returns:

BusinessList

Throws:

javax.ws.rs.WebApplicationException

getServiceSearchJSON

@GET
 @Path(value="/JSON/serviceSearch")
 @Produces(value="application/json")
public ServiceList getServiceSearchJSON(@QueryParam(value="name")
                                                                                                                         String name,
                                                                                                                         @QueryParam(value="lang")
                                                                                                                         String lang,
                                                                                                                         @QueryParam(value="findQualifiers")
                                                                                                                         String findQualifiers,
                                                                                                                         @QueryParam(value="maxrows")
                                                                                                                         Integer maxrows,
                                                                                                                         @QueryParam(value="offset")
                                                                                                                         Integer offset)
                                                                                                                  throws javax.ws.rs.WebApplicationException

Returns the search results for registered services in JSON

Parameters:

name -

lang -

findQualifiers -

maxrows -

offset -

Returns:

serviceList

Throws:

javax.ws.rs.WebApplicationException

getServiceSearchXML

@GET
 @Path(value="/XML/serviceSearch")
 @Produces(value="application/json")
public ServiceList getServiceSearchXML(@QueryParam(value="name")
                                                                                                                       String name,
                                                                                                                       @QueryParam(value="lang")
                                                                                                                       String lang,
                                                                                                                       @QueryParam(value="findQualifiers")
                                                                                                                       String findQualifiers,
                                                                                                                       @QueryParam(value="maxrows")
                                                                                                                       Integer maxrows,
                                                                                                                       @QueryParam(value="offset")
                                                                                                                       Integer offset)
                                                                                                                throws javax.ws.rs.WebApplicationException

Returns the search results for registered services in XML

Parameters:

name -

lang -

findQualifiers -

maxrows -

offset -

Returns:

serviceList

Throws:

javax.ws.rs.WebApplicationException

getTModelListJSON

@GET
 @Path(value="/JSON/tModelList")
 @Produces(value="application/json")
public KeyBag getTModelListJSON()
                                                                                                       throws javax.ws.rs.WebApplicationException

Returns the tModel keys of the first 100 registered services in JSON

Returns:

json

Throws:

javax.ws.rs.WebApplicationException

getTModelSearchJSON

@GET
 @Path(value="/JSON/searchTModel")
 @Produces(value="application/json")
public TModelList getTModelSearchJSON(@QueryParam(value="name")
                                                                                                                      String name,
                                                                                                                      @QueryParam(value="lang")
                                                                                                                      String lang,
                                                                                                                      @QueryParam(value="findQualifiers")
                                                                                                                      String findQualifiers,
                                                                                                                      @QueryParam(value="maxrows")
                                                                                                                      Integer maxrows,
                                                                                                                      @QueryParam(value="offset")
                                                                                                                      Integer offset)
                                                                                                               throws javax.ws.rs.WebApplicationException

Returns the search results for registered tModel in JSON

Parameters:

name -

lang -

findQualifiers -

maxrows -

offset -

Returns:

TModelList

Throws:

javax.ws.rs.WebApplicationException

getTModelSearchXML

@GET
 @Path(value="/XML/searchTModel")
 @Produces(value="application/json")
public TModelList getTModelSearchXML(@QueryParam(value="name")
                                                                                                                    String name,
                                                                                                                    @QueryParam(value="lang")
                                                                                                                    String lang,
                                                                                                                    @QueryParam(value="findQualifiers")
                                                                                                                    String findQualifiers,
                                                                                                                    @QueryParam(value="maxrows")
                                                                                                                    Integer maxrows,
                                                                                                                    @QueryParam(value="offset")
                                                                                                                    Integer offset)
                                                                                                             throws javax.ws.rs.WebApplicationException

Returns the search results for registered tModel in XML

Parameters:

name -

lang -

findQualifiers -

maxrows -

offset -

Returns:

TModelList

Throws:

javax.ws.rs.WebApplicationException