Skip navigation links

oracle.search.admin.api.ws.client
Class AdminService

java.lang.Object
javax.xml.ws.Service
oracle.search.admin.api.ws.client.AdminService

public class AdminService

extends javax.xml.ws.Service

The service implementation for the Administration API Web Service. It is the main entry point to perform administrative operations. The service must be initialized using the Web Service WSDL URL and the fully qualified service name. Once the service is initialized, an AdminPortType can be retrieved to perform administration operations.

The WSDL is represented by a java.net.URL and has the following format:

    http://<sesHost>:<sesPort>/search/api/admin/AdminService
 

where sesHost and sesPort are the Oracle Secure Enterprise Search host and port.

The service name is represented by a javax.xml.namespace.QName and must be initialized using the namespace URL "http://search.oracle.com/Admin" and the local part "AdminService".

For example, the following initializes an AdminService and retrieves an AdminPortType:

   AdminService service = new AdminService(
     new java.net.URL( "http://localhost:7777/search/api/admin/AdminService" ),
     new javax.xml.namespace.QName( "http://search.oracle.com/Admin", "AdminService" )
   ); 
   AdminPortType port = service.getAdmin();
 

Nested Class Summary

Nested classes/interfaces inherited from class javax.xml.ws.Service

javax.xml.ws.Service.Mode

Constructor Summary

AdminService(URL wsdlLocation, QName serviceName)
Initializes the AdminService with the WSDL location and service name.

Method Summary

AdminPortType

getAdmin() Returns the AdminPortType for this service.

Methods inherited from class javax.xml.ws.Service

addPort, create, create, createDispatch, createDispatch, createDispatch, createDispatch, createDispatch, createDispatch, getExecutor, getHandlerResolver, getPort, getPort, getPort, getPort, getPort, getPorts, getServiceName, getWSDLDocumentLocation, setExecutor, setHandlerResolver

Methods inherited from class java.lang.Object

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

Constructor Detail

AdminService

public AdminService(URL wsdlLocation,
                    QName serviceName)

Initializes the AdminService with the WSDL location and service name.

Parameters:

wsdlLocation - The URL representing the WSDL location.

serviceName - The fully qualified service name as a QName. The namespace URI must be "http://search.oracle.com/Admin" and the local part must be "AdminService".

Method Detail

getAdmin

@WebEndpoint(name="Admin")
public AdminPortType getAdmin()

Returns the AdminPortType for this service. The AdminPortType is used to execute the main API operations.

Returns:

The AdminPortType for this service.

Skip navigation links