com.centrasite.jaxr
Interface CentraSiteConnection

All Superinterfaces:
javax.xml.registry.Connection

public interface CentraSiteConnection
extends javax.xml.registry.Connection

Defines CentraSite extensions of the JAXR Connection interface.


Field Summary
static java.lang.String SSL_FILE_PROPERTY
          Property for the SSL property file
 
Method Summary
 void commit()
          Commit the current transaction for a connection with client transaction control.
 java.util.ArrayList<java.lang.String> getAdditionalFeatures()
          return the additional features specified in the license file
 java.util.Collection getAllRoles()
          Deprecated.  
 java.lang.String getEdition()
          return the server edition specified in the license file
 java.util.Locale getErrorMessageLocale()
          Return the error message locale.
 java.lang.String getQueryManagerURL()
          Get the queryManagerURL.
 javax.xml.xquery.XQConnection getReadonlyXQConnection()
          Gets the read-only XQJ connection object for JAXR clients.
 java.util.Properties getSSLProperties()
          Get the SSL properties from the connection.
 javax.xml.registry.infomodel.Organization getSubmittingOrganization()
          Get default submitting organization.
 java.util.Collection getUserRoles()
          Get roles for authenticated user of the connection.
 javax.xml.xquery.XQConnection getXQConnection()
          Gets the XQJ connection object for JAXR clients.
 javax.xml.xquery.XQConnection getXQUpdateConnection()
          Gets the XQJ connection object for updates.
 boolean isActiveSoaEdition()
          Return whether the server has an ActiveSoaEdition license
 boolean isAdditionalFeatureLicensed(java.lang.String feature)
          return whether a specified additional feature is licensed
 boolean isEnterpriseEdition()
          Return whether the server has an EnterpriseEdition license
 void lock(java.util.Collection registryObjects, java.util.Collection lockQualifiers)
          Lock the given registry objects exclusively according to the given lock options.
 void rollback()
          Rollback the current transaction.
 void setSubmittingOrganization(javax.xml.registry.infomodel.Organization organization)
          Set default submitting organization.
 
Methods inherited from interface javax.xml.registry.Connection
close, getCredentials, getRegistryService, isClosed, isSynchronous, setCredentials, setSynchronous
 

Field Detail

SSL_FILE_PROPERTY

static final java.lang.String SSL_FILE_PROPERTY
Property for the SSL property file

See Also:
Constant Field Values
Method Detail

isEnterpriseEdition

boolean isEnterpriseEdition()
                            throws javax.xml.registry.JAXRException
Return whether the server has an EnterpriseEdition license

Returns:
true if the server has an EnterpriseEdition license
Throws:
javax.xml.registry.JAXRException

isActiveSoaEdition

boolean isActiveSoaEdition()
                           throws javax.xml.registry.JAXRException
Return whether the server has an ActiveSoaEdition license

Returns:
true if the server has an ActiveSoaEdition license
Throws:
javax.xml.registry.JAXRException

getEdition

java.lang.String getEdition()
                            throws javax.xml.registry.JAXRException
return the server edition specified in the license file

Returns:
the server edition specified in the license file
Throws:
javax.xml.registry.JAXRException

getAdditionalFeatures

java.util.ArrayList<java.lang.String> getAdditionalFeatures()
                                                            throws javax.xml.registry.JAXRException
return the additional features specified in the license file

Returns:
the aditional features specified in the license file
Throws:
javax.xml.registry.JAXRException

isAdditionalFeatureLicensed

boolean isAdditionalFeatureLicensed(java.lang.String feature)
                                    throws javax.xml.registry.JAXRException
return whether a specified additional feature is licensed

Parameters:
feature - the feature to be checked
Returns:
true if a specified additional feature is licensed
Throws:
javax.xml.registry.JAXRException

getErrorMessageLocale

java.util.Locale getErrorMessageLocale()
Return the error message locale.

Returns:
the error message locale - if none was specified this is the current default locale.

getQueryManagerURL

java.lang.String getQueryManagerURL()
Get the queryManagerURL.

Returns:
the queryManagerURL

lock

void lock(java.util.Collection registryObjects,
          java.util.Collection lockQualifiers)
          throws javax.xml.registry.JAXRException
Lock the given registry objects exclusively according to the given lock options. If the given objects are not in sync with the database state throw an ObjectOutdatedException.

  • LockQualifier.LOCK_NOWAIT: throw a LockNotAvailableException if not all objects could be locked.

    If LOCK_NOWAIT is not specified wait until all locks have been granted.

    Parameters:
    registryObjects - the collection of registry objects to be locked. Maybe empty but not null.
    lockQualifiers - the collection of lock qualifiers
    Throws:
    javax.xml.registry.JAXRException
    See Also:
    LockQualifier, rollback()

  • commit

    void commit()
                throws javax.xml.registry.JAXRException
    Commit the current transaction for a connection with client transaction control.

    Throws:
    javax.xml.registry.JAXRException

    rollback

    void rollback()
                  throws javax.xml.registry.JAXRException
    Rollback the current transaction. In particular, release all locks acquired via the lock() method.

    Throws:
    javax.xml.registry.JAXRException
    See Also:
    lock(java.util.Collection, java.util.Collection)

    getReadonlyXQConnection

    javax.xml.xquery.XQConnection getReadonlyXQConnection()
                                                          throws javax.xml.registry.JAXRException
    Gets the read-only XQJ connection object for JAXR clients. If the JAXR connection was created with BrowserBehaviour=yes this will be the real read-only connection, otherwise it will be the normal connection that also allows update commands.

    Returns:
    the XQJ read-only connection object
    Throws:
    javax.xml.registry.JAXRException

    getXQConnection

    javax.xml.xquery.XQConnection getXQConnection()
                                                  throws javax.xml.registry.JAXRException
    Gets the XQJ connection object for JAXR clients.

    Returns:
    the XQJ connection object
    Throws:
    javax.xml.registry.JAXRException

    getXQUpdateConnection

    javax.xml.xquery.XQConnection getXQUpdateConnection()
                                                        throws javax.xml.registry.JAXRException
    Gets the XQJ connection object for updates.

    Returns:
    the XQJ connection object for updates
    Throws:
    javax.xml.registry.JAXRException

    getUserRoles

    java.util.Collection getUserRoles()
                                      throws javax.xml.registry.JAXRException
    Get roles for authenticated user of the connection.

    Returns:
    collection of role names - maybe empty but not null
    Throws:
    javax.xml.registry.JAXRException - if a registry error occurs

    getAllRoles

    java.util.Collection getAllRoles()
                                     throws javax.xml.registry.JAXRException
    Deprecated. 

    Get all roles for this connection.

    Returns:
    collection of role names - maybe empty but not null
    Throws:
    javax.xml.registry.JAXRException - if a registry error occurs

    getSubmittingOrganization

    javax.xml.registry.infomodel.Organization getSubmittingOrganization()
                                                                        throws javax.xml.registry.JAXRException
    Get default submitting organization.

    Throws:
    javax.xml.registry.JAXRException - if a registry error occurs

    setSubmittingOrganization

    void setSubmittingOrganization(javax.xml.registry.infomodel.Organization organization)
                                   throws javax.xml.registry.JAXRException
    Set default submitting organization.

    Throws:
    javax.xml.registry.JAXRException - if a registry error occurs

    getSSLProperties

    java.util.Properties getSSLProperties()
    Get the SSL properties from the connection.

    Returns:
    the SSL properties (null: no ssl used)