uk.ac.soton.itinnovation.grid.comms.ogsadai
Interface OgsaDaiSubscription

All Superinterfaces:

DataResourceSubscription, IdentifiableResource, PolicyManagement, ResourceMetadata, WSResourceLifetime

All Known Subinterfaces:

OgsaDaiSubscriptionConversation

All Known Implementing Classes:

OgsaDaiServiceI2Impl, OgsaDaiServiceImpl

@WebService(targetNamespace="http://ogsadai.org.uk/namespaces/2005/10/service/wsi/dataservice/service",
            name="OgsaDaiSubscription",
            wsdlLocation="ogsadaisubscription.wsdl",
            serviceName="OgsaDaiSubscription")
@SoapBindingName(value="OgsaDaiSubscriptionSoapBinding")
public interface OgsaDaiSubscription
extends DataResourceSubscription

Field Summary

static String

RESOURCE_TYPE

Method Summary

void	checkPolicyRule(SubjectDescription client, String action) The method first checks to see if the current user (the caller) is permitted to invoke the operation checkPolicyRule.
String	executeSelect(MatchRule rule, String sql) Deprecated. Users should now construct perform documents on the client side using OGSA-DAI libraries
String	executeUpdate(MatchRule rule, String sql) Deprecated. Users should now construct perform documents on the client side using OGSA-DAI libraries
ExtensibilityType	getBlock(String id) Compatibility method for OGSA-DAI clients.
ExtensibilityType	getFully(String id) Compatibility method for OGSA-DAI clients.
Document	GetMultipleResourceProperties(GetMultipleResourcePropertiesRequest getMultipleResourcePropertiesRequest) Compatibility method for OGSA-DAI clients.
ExtensibilityType	getNBlocks(String id, int numberOfBlocks) Compatibility method for OGSA-DAI clients.
Document	GetResourceProperty(QName getResourcePropertyRequest) Compatibility method for OGSA-DAI clients.
String	getVersion() Returns the OGSA-DAI version This is an OGSA-DAI compatibility method, and is used by the OGSA-DAI client.
String[]	listResources(String listResourcesVoid) List the caller's subscriptions This is an OGSA-DAI compatibility method, and is used by the OGSA-DAI client.
ExtensibilityType	perform(ExtensibilityType sql) Executes a perform document on the database.
ExtensibilityType	performWithRule(MatchRule rule, ExtensibilityType sql) Executes a perform document on the database.
void	putBlock(String id, ExtensibilityType data) Compatibility method for OGSA-DAI clients.
void	putFully(String id, ExtensibilityType data) Compatibility method for OGSA-DAI clients.

Methods inherited from interface uk.ac.soton.itinnovation.grid.comms.wsrf.WSResourceLifetime

destroy

Methods inherited from interface uk.ac.soton.itinnovation.grid.types.ResourceMetadata

getEPR, setLabel

Methods inherited from interface uk.ac.soton.itinnovation.grid.types.PolicyManagement

addPolicyRule, getPolicyRules, getValidRoles, removePolicyRule

Methods inherited from interface uk.ac.soton.itinnovation.grid.types.IdentifiableResource

getServiceMatchPattern

Field Detail

RESOURCE_TYPE

static final String RESOURCE_TYPE

See Also:

Constant Field Values

Method Detail

executeSelect

@Deprecated
@WebMethod
String executeSelect(MatchRule rule,
                                          String sql)
                     throws RemoteException

Deprecated. Users should now construct perform documents on the client side using OGSA-DAI libraries

Convenience method that executes an SQL select query on the database. Internally this creates a perform document containing a SQLQuery, then calls perform(uk.org.ogsadai.types.ExtensibilityType)

Parameters:

rule - A match rule for the 'owner' role on any sessions that are created as a result of this call.

sql - An SQL SELECT query

Returns:

A serialised OGSA-DAI response document.

Throws:

RemoteException

executeUpdate

@Deprecated
@WebMethod
String executeUpdate(MatchRule rule,
                                          String sql)
                     throws RemoteException

Deprecated. Users should now construct perform documents on the client side using OGSA-DAI libraries

Convenience method that executes an SQL update or insert query on the database. Internally this creates a perform document containing a SQLUpdate, then calls perform(uk.org.ogsadai.types.ExtensibilityType)

Parameters:

rule - A match rule for the 'owner' role on any sessions that are created as a result of this call.

sql - An SQL UPDATE query

Returns:

A serialised OGSA-DAI response document.

Throws:

RemoteException

perform

@WebMethod(returnElementName="response",
           returnNamespace="http://ogsadai.org.uk/namespaces/2005/10/types")
ExtensibilityType perform(ExtensibilityType sql)
                          throws RemoteException,
                                 DAIException

Executes a perform document on the database. Note that a MatchRule must be specified in the soap header.

Parameters:

sql - An OGSA-DAI perform document

Returns:

An OGSA-DAI response document

Throws:

RemoteException

DAIException

performWithRule

@WebMethod
ExtensibilityType performWithRule(MatchRule rule,
                                            ExtensibilityType sql)
                                  throws RemoteException,
                                         DAIException

Executes a perform document on the database.

Parameters:

rule - A match rule for the 'owner' role on any sessions that are created as a result of this call.

sql - An OGSA-DAI perform document

Returns:

An OGSA-DAI response document

Throws:

RemoteException

DAIException

putFully

@WebMethod
void putFully(String id,
                        ExtensibilityType data)
              throws RemoteException,
                     ResourceBusyFaultType,
                     ResourceUnknownFaultType,
                     InternalFaultType,
                     RequestFaultType,
                     AuthorisationFaultType

Compatibility method for OGSA-DAI clients.

Throws:

RemoteException

ResourceBusyFaultType

ResourceUnknownFaultType

InternalFaultType

RequestFaultType

AuthorisationFaultType

putBlock

@WebMethod
void putBlock(String id,
                        ExtensibilityType data)
              throws RemoteException,
                     ResourceBusyFaultType,
                     ResourceUnknownFaultType,
                     InternalFaultType,
                     RequestFaultType,
                     AuthorisationFaultType

Compatibility method for OGSA-DAI clients.

Throws:

RemoteException

ResourceBusyFaultType

ResourceUnknownFaultType

InternalFaultType

RequestFaultType

AuthorisationFaultType

getFully

@WebMethod(returnElementName="result",
           returnNamespace="http://ogsadai.org.uk/namespaces/2005/10/service/transport/types")
ExtensibilityType getFully(String id)
                           throws RemoteException,
                                  ResourceBusyFaultType,
                                  ResourceUnknownFaultType,
                                  InternalFaultType,
                                  RequestFaultType,
                                  AuthorisationFaultType

Compatibility method for OGSA-DAI clients.

Throws:

RemoteException

ResourceBusyFaultType

ResourceUnknownFaultType

InternalFaultType

RequestFaultType

AuthorisationFaultType

getBlock

@WebMethod(returnElementName="result",
           returnNamespace="http://ogsadai.org.uk/namespaces/2005/10/service/transport/types")
ExtensibilityType getBlock(String id)
                           throws RemoteException,
                                  ResourceBusyFaultType,
                                  ResourceUnknownFaultType,
                                  InternalFaultType,
                                  RequestFaultType,
                                  AuthorisationFaultType

Compatibility method for OGSA-DAI clients.

Throws:

RemoteException

ResourceBusyFaultType

ResourceUnknownFaultType

InternalFaultType

RequestFaultType

AuthorisationFaultType

getNBlocks

@WebMethod(returnElementName="result",
           returnNamespace="http://ogsadai.org.uk/namespaces/2005/10/service/transport/types")
ExtensibilityType getNBlocks(String id,
                                                                       int numberOfBlocks)
                             throws RemoteException,
                                    ResourceBusyFaultType,
                                    ResourceUnknownFaultType,
                                    InternalFaultType,
                                    RequestFaultType,
                                    AuthorisationFaultType

Compatibility method for OGSA-DAI clients.

Throws:

RemoteException

ResourceBusyFaultType

ResourceUnknownFaultType

InternalFaultType

RequestFaultType

AuthorisationFaultType

listResources

@WebMethod(returnElementName="resource",
           returnNamespace="http://ogsadai.org.uk/namespaces/2005/10/service/types")
String[] listResources(String listResourcesVoid)
                       throws RemoteException

List the caller's subscriptions This is an OGSA-DAI compatibility method, and is used by the OGSA-DAI client.

Parameters:

listResourcesVoid - Unused

Returns:

An array of resource IDs

Throws:

RemoteException

getVersion

@WebMethod(returnElementName="version",
           returnNamespace="http://ogsadai.org.uk/namespaces/2005/10/service/types")
String getVersion()
                  throws RemoteException

Returns the OGSA-DAI version This is an OGSA-DAI compatibility method, and is used by the OGSA-DAI client.

Returns:

A version string

Throws:

RemoteException

GetMultipleResourceProperties

@WebMethod(returnElementName="GetMultipleResourcePropertiesResponse",
           returnNamespace="http://www.ibm.com/xmlns/stdwip/web-services/WS-ResourceProperties")
Document GetMultipleResourceProperties(GetMultipleResourcePropertiesRequest getMultipleResourcePropertiesRequest)
                                       throws InvalidResourcePropertyQNameFaultType,
                                              ResourceUnknownFaultType,
                                              RemoteException,
                                              Exception

Compatibility method for OGSA-DAI clients.

Parameters:

getMultipleResourcePropertiesRequest -

Returns:

Document

Throws:

InvalidResourcePropertyQNameFaultType

ResourceUnknownFaultType

RemoteException

Exception

GetResourceProperty

@WebMethod(returnElementName="GetResourcePropertyResponse",
           returnNamespace="http://www.ibm.com/xmlns/stdwip/web-services/WS-ResourceProperties")
Document GetResourceProperty(QName getResourcePropertyRequest)
                             throws InvalidResourcePropertyQNameFaultType,
                                    ResourceUnknownFaultType,
                                    RemoteException

Compatibility method for OGSA-DAI clients.

Parameters:

getResourcePropertyRequest -

Returns:

Document

Throws:

InvalidResourcePropertyQNameFaultType

ResourceUnknownFaultType

RemoteException

checkPolicyRule

@WebMethod
void checkPolicyRule(SubjectDescription client,
                               String action)
                     throws RemoteException

The method first checks to see if the current user (the caller) is permitted to invoke the operation checkPolicyRule. However, it uses this system of adding in more context from the call's parameters, so we don't just check to see if they can checkPolicyRule but we see if they are permitted to e.g. checkPolicyRule:perform to see if they are permitted to check if someone else can use the perform method. Once that check passes then it goes on to check if the client (that the intermediary is acting on behalf of) is permitted to invoke the operation.

Parameters:

client -

action -

Throws:

RemoteException