com.prosysopc.ua.stack.application

Class Server

java.lang.Object

com.prosysopc.ua.stack.application.Server

Direct Known Subclasses:

UaServer.DiscoveryServer

public class Server
extends Object

This object represents a service server. It is an application that responds to ServiceRequests queries.

Server is assigned with at least one application instance certificate.

The initial server contains EndpointDiscoveryService by default.

See Also:

Application, service handler

Field Summary

Fields

Modifier and Type	Field and Description
protected Application	application The application
protected List<EndpointServer.EndpointHandle>	boundHandles Bound handles
protected EndpointBindingCollection	endpointBindings Endpoints
protected EndpointDiscoveryService	endpointDiscoveryService Endpoint discovery service
static String	HTTPS_BINARY_TRANSPORT_PROFILE_URI Deprecated. Use UriUtil.HTTPS_BINARY_TRANSPORT_PROFILE_URI instead
protected ServiceHandlerComposition	serviceHandlers Service Handler
static String	SOAP_XML_TRANSPORT_PROFILE_URI Deprecated. Use UriUtil.SOAP_XML_TRANSPORT_PROFILE_URI instead
static String	UATCP_BINARY_TRANSPORT_PROFILE_URI Deprecated. Use UriUtil.UATCP_BINARY_TRANSPORT_PROFILE_URI instead
protected List<UserTokenPolicy>	userTokenPolicies User Token Policies

Constructor Summary

Constructors

Constructor and Description
Server(Application application) Constructor for Server.

Method Summary

Modifier and Type	Method and Description
void	addServiceHandler(Object serviceHandler) Add Service Handler.
void	addUserTokenPolicy(UserTokenPolicy policy) addUserTokenPolicy.
List<EndpointServer.EndpointHandle>	bind(String bindAddress, Endpoint endpointAddress) Bind an endpoint to the server.
List<EndpointServer.EndpointHandle>	bind(String bindAddress, String endpointUri, Collection<SecurityMode> modes)
List<EndpointServer.EndpointHandle>	bind(String bindAddress, String endpointUri, SecurityMode... modes) bind.
EndpointServer.ReverseEndpointHandle	bindReverse(ReverseConnectionParameters parameters, ScheduledExecutorService retryScheduledExecutorService) Binds a "ReverseHello" pseudo-endpoint to the server.
void	close() Close the server.
ApplicationDescription	createApplicationDescription() createApplicationDescription.
static Server	createServerApplication() createServerApplication.
Application	getApplication() Getter for the field application.
EndpointServer[]	getBindings() getBindings.
EncoderContext	getEncoderContext() getEncoderContext.
EndpointBindingCollection	getEndpointBindings() Getter for the field endpointBindings.
Endpoint	getEndpointByUri(String uri) getEndpointByUri.
EndpointDescription[]	getEndpointDescriptions() getEndpointDescriptions.
EndpointDescription[]	getEndpointDescriptions(SocketAddress requestAddress) getEndpointDescriptions.
Endpoint[]	getEndpoints() getEndpoints.
EndpointServer	getOrCreateEndpointServer(String scheme) getOrCreateEndpointServer.
HttpsServer	getOrCreateHttpsServer() getOrCreateHttpsServer.
OpcTcpServer	getOrCreateOpcTcpServer() getOrCreateOpcTcpServer.
<T> T	getServiceHandlerByService(Class<? extends ServiceRequest> requestClass) Get Service Handler object by service.
ServiceHandlerComposition	getServiceHandlerComposition() getServiceHandlerComposition.
ServiceHandler[]	getServiceHandlers() Getter for the field serviceHandlers.
UserTokenPolicy[]	getUserTokenPolicies() Getter for the field userTokenPolicies.
boolean	handlesService(Class<? extends IEncodeable> requestClass) Query whether the server can handle a service.
boolean	hasEndpoint(String uri) hasEndpoint.
void	removeUserTokenPolicy(UserTokenPolicy policy) removeUserTokenPolicy.
void	setEndpointBindings(EndpointBindingCollection newBindings) Setter for the field endpointBindings.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SOAP_XML_TRANSPORT_PROFILE_URI

@Deprecated
public static final String SOAP_XML_TRANSPORT_PROFILE_URI

Deprecated. Use UriUtil.SOAP_XML_TRANSPORT_PROFILE_URI instead

Constant SOAP_XML_TRANSPORT_PROFILE_URI="http://opcfoundation.org/UA-Profile/Tra"{trunked}

See Also:

Constant Field Values

UATCP_BINARY_TRANSPORT_PROFILE_URI

@Deprecated
public static final String UATCP_BINARY_TRANSPORT_PROFILE_URI

Deprecated. Use UriUtil.UATCP_BINARY_TRANSPORT_PROFILE_URI instead

Constant UATCP_BINARY_TRANSPORT_PROFILE_URI="http://opcfoundation.org/UA-Profile/Tra"{trunked}

See Also:

Constant Field Values

HTTPS_BINARY_TRANSPORT_PROFILE_URI

@Deprecated
public static final String HTTPS_BINARY_TRANSPORT_PROFILE_URI

Deprecated. Use UriUtil.HTTPS_BINARY_TRANSPORT_PROFILE_URI instead

Constant HTTPS_BINARY_TRANSPORT_PROFILE_URI="http://opcfoundation.org/UA-Profile/Tra"{trunked}

See Also:

Constant Field Values

serviceHandlers

protected ServiceHandlerComposition serviceHandlers

Service Handler

userTokenPolicies

protected List<UserTokenPolicy> userTokenPolicies

User Token Policies

endpointBindings

protected EndpointBindingCollection endpointBindings

Endpoints

endpointDiscoveryService

protected EndpointDiscoveryService endpointDiscoveryService

Endpoint discovery service

application

protected Application application

The application

boundHandles

protected List<EndpointServer.EndpointHandle> boundHandles

Bound handles

Constructor Detail

Server

public Server(Application application)

Constructor for Server.

Parameters:

application - a Application object.

Method Detail

createServerApplication

public static Server createServerApplication()

createServerApplication.

Returns:

a Server object.

addServiceHandler

public void addServiceHandler(Object serviceHandler)

Add Service Handler. Service handler handles one or more service methods. Note, the server may not have more than one service handler for each method.

The serviceHandler is either: (a) an implementation of ServiceHandler (b) an object that contains methods that implement service requests. These methods are discovered using Java Reflection.

The following list contains service methods grouped by service sets:

Parameters:

serviceHandler - instanceof ServiceHandler or Object implementing service requests

See Also:

com.prosysopc.ua.stack.core.AttributeServiceSetHandler, com.prosysopc.ua.stack.core.DiscoveryServiceSetHandler, com.prosysopc.ua.stack.core.MethodServiceSetHandler, com.prosysopc.ua.stack.core.MonitoredItemServiceSetHandler, com.prosysopc.ua.stack.core.NodeManagementServiceSetHandler, com.prosysopc.ua.stack.core.SessionServiceSetHandler, com.prosysopc.ua.stack.core.SubscriptionServiceSetHandler,

The serviceHandler may implement one or more methods. In typical case service handler implements one service set, e.g. {@link com.prosysopc.ua.stack.core.SessionServiceSetHandler}.

A {@link com.prosysopc.ua.stack.core.ServiceFault} is returned to the client in case the server doesn't the requested service method.

Example: addServiceHandler( new TestServiceSetHandler() { void onTestStack(EndpointServiceRequest<TestStackRequest, TestStackResponse> req) { req.sendResponse( new ServiceFault() ); } void onTestStackEx(EndpointServiceRequest<TestStackExRequest, TestStackExResponse> req) { req.sendFault(new ServiceFault()); } } );

addUserTokenPolicy

public void addUserTokenPolicy(UserTokenPolicy policy)

addUserTokenPolicy.

Parameters:

policy - a UserTokenPolicy object.

bind

public List<EndpointServer.EndpointHandle> bind(String bindAddress,
                                                Endpoint endpointAddress)
                                         throws ServiceResultException

Bind an endpoint to the server. bindAddress is resolved into ip-addresses. For instance, if "localhost" is used, then all local interface ips are bound. If port is not explicitly specified, the default port for the protocol is used. There must be protocol: "opc.tcp", "http", or "https". EndpointUri is the identifier of the endpoint.

Parameters:

bindAddress - bind address for the endpoint

endpointAddress - endpoint to bind

Returns:

list of handles

Throws:

ServiceResultException - if error

bind

public List<EndpointServer.EndpointHandle> bind(String bindAddress,
                                                String endpointUri,
                                                Collection<SecurityMode> modes)
                                         throws ServiceResultException

Throws:

ServiceResultException

bind

public List<EndpointServer.EndpointHandle> bind(String bindAddress,
                                                String endpointUri,
                                                SecurityMode... modes)
                                         throws ServiceResultException

bind.

Parameters:

bindAddress - a String object.

endpointUri - a String object.

modes - a SecurityMode object.

Returns:

a List object.

Throws:

ServiceResultException - if any.

bindReverse

public EndpointServer.ReverseEndpointHandle bindReverse(ReverseConnectionParameters parameters,
                                                        ScheduledExecutorService retryScheduledExecutorService)
                                                 throws ServiceResultException

Binds a "ReverseHello" pseudo-endpoint to the server. Server will connect the clients based on Part 6 ReverseHello connection Procedure. Note that this works only for opc.tcp at the moment.

Parameters:

parameters - for forming and handling the connection

retryScheduledExecutorService - ScheduledExecutorService for reconnecting scheduling

Returns:

a handle to the endpoint

Throws:

ServiceResultException - if any error

close

public void close()

Close the server.

createApplicationDescription

public ApplicationDescription createApplicationDescription()

createApplicationDescription.

Returns:

a ApplicationDescription object.

getApplication

public Application getApplication()

Getter for the field application.

Returns:

a Application object.

getBindings

public EndpointServer[] getBindings()

getBindings.

Returns:

an array of EndpointServer objects.

getEncoderContext

public EncoderContext getEncoderContext()

getEncoderContext.

Returns:

a EncoderContext object.

getEndpointBindings

public EndpointBindingCollection getEndpointBindings()

Getter for the field endpointBindings.

Returns:

a EndpointBindingCollection object.

getEndpointByUri

public Endpoint getEndpointByUri(String uri)

getEndpointByUri.

Parameters:

uri - a String object.

Returns:

a Endpoint object.

getEndpointDescriptions

public EndpointDescription[] getEndpointDescriptions()

getEndpointDescriptions.

Returns:

an array of EndpointDescription objects.

getEndpointDescriptions

public EndpointDescription[] getEndpointDescriptions(SocketAddress requestAddress)

getEndpointDescriptions.

Parameters:

requestAddress - a SocketAddress object.

Returns:

an array of EndpointDescription objects.

getEndpoints

public Endpoint[] getEndpoints()

getEndpoints.

Returns:

an array of Endpoint objects.

getOrCreateEndpointServer

public EndpointServer getOrCreateEndpointServer(String scheme)
                                         throws ServiceResultException

getOrCreateEndpointServer.

Parameters:

scheme - a String object.

Returns:

a EndpointServer object.

Throws:

ServiceResultException - if any.

getOrCreateHttpsServer

public HttpsServer getOrCreateHttpsServer()
                                   throws ServiceResultException

getOrCreateHttpsServer.

Returns:

a HttpsServer object.

Throws:

ServiceResultException - if any.

getOrCreateOpcTcpServer

public OpcTcpServer getOrCreateOpcTcpServer()
                                     throws ServiceResultException

getOrCreateOpcTcpServer.

Returns:

a OpcTcpServer object.

Throws:

ServiceResultException - if any.

getServiceHandlerByService

public <T> T getServiceHandlerByService(Class<? extends ServiceRequest> requestClass)

Get Service Handler object by service.

For example, to acquire session manager: SessionManager sessionManager = x.getServiceHandlerByService( CreateSessionRequest.class );

Type Parameters:

T - service handler type

Parameters:

requestClass - Service request class

Returns:

Service handler that serves the given request class in this server

getServiceHandlerComposition

public ServiceHandlerComposition getServiceHandlerComposition()

getServiceHandlerComposition.

Returns:

a ServiceHandlerComposition object.

getServiceHandlers

public ServiceHandler[] getServiceHandlers()

Getter for the field serviceHandlers.

Returns:

an array of ServiceHandler objects.

getUserTokenPolicies

public UserTokenPolicy[] getUserTokenPolicies()

Getter for the field userTokenPolicies.

Returns:

an array of UserTokenPolicy objects.

handlesService

public boolean handlesService(Class<? extends IEncodeable> requestClass)

Query whether the server can handle a service.

Parameters:

requestClass - request class of the service, e.g. ReadRequest

Returns:

true if server can handle the service

hasEndpoint

public boolean hasEndpoint(String uri)

hasEndpoint.

Parameters:

uri - a String object.

Returns:

a boolean.

removeUserTokenPolicy

public void removeUserTokenPolicy(UserTokenPolicy policy)

removeUserTokenPolicy.

Parameters:

policy - a UserTokenPolicy object.

setEndpointBindings

public void setEndpointBindings(EndpointBindingCollection newBindings)

Setter for the field endpointBindings.

Parameters:

newBindings - a EndpointBindingCollection object.

toString

public String toString()

Overrides:

toString in class Object