Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.modeshape.jdbc.delegate
Interface RepositoryDelegate

All Known Implementing Classes:
  AbstractRepositoryDelegate, HttpRepositoryDelegate, LocalRepositoryDelegate

    public interface RepositoryDelegate

Represents the communication interface thru which the JDBC logic will obtain a connection and issue commands to the Jcr layer.

Method Summary
`void` | `close()` Call to close the delegate connection and any outstanding transactions will be closed.
`void` | `closeStatement()` Called when the `Statement` the is closed.
`void` | `commit()`
`Connection` | `createConnection(DriverInfo info)` Call to create the connection based on the implementation of this interface.
`QueryResult` | `execute(String query, String language)` Call to execute the sql `query` based on the specified Jcr language.
`ConnectionInfo` | `getConnectionInfo()` Call to get the connection information.
`String` | `getDescriptor(String descriptorKey)` Returns the value for the requested `descriptorKey`
`Set<String>` | `getRepositoryNames()` Called to get all the repository names currently available in the JcrEngine.
`boolean` | `isValid(int timeout)`
`boolean` | `isWrapperFor(Class<?> iface)`
`NodeType` | `nodeType(String name)` Call to get `NodeType` based on specified name
`List<NodeType>` | `nodeTypes()` Call to get all the `NodeType`s defined.
`void` | `rollback()`
`
`<T> T`
` | `unwrap(Class<T> iface)`

Method Detail

### getConnectionInfo

    ConnectionInfo getConnectionInfo()

  Call to get the connection information.

  Returns:
    ConnectionInfo

### closeStatement

    void closeStatement()

  Called when the `Statement` the is closed. This enables the underlying connection to the JcrRepository remain open until the statement is finished using it.

### close

    void close()

  Call to close the delegate connection and any outstanding transactions will be closed.

  See Also:
    `Connection.close()`

### nodeType

    NodeType nodeType(String name)
                      throws RepositoryException

  Call to get `NodeType` based on specified name

  Parameters:
    `name` -
  Returns:
    NodeType
  Throws:
    `RepositoryException`

### nodeTypes

    List<NodeType> nodeTypes()
                             throws RepositoryException

  Call to get all the `NodeType`s defined.

  Returns:
    List of all the node types.
  Throws:
    `RepositoryException`

### execute

    QueryResult execute(String query,
                        String language)
                        throws RepositoryException

  Call to execute the sql `query` based on the specified Jcr language.

  Parameters:
    `query` - is the sql query to execute
    `language` - is the JCR language the `query` should be executed based on.
  Returns:
    QueryResult is the JCR query result
  Throws:
    `RepositoryException`

### createConnection

    Connection createConnection(DriverInfo info)
                                throws SQLException

  Call to create the connection based on the implementation of this interface.

  Parameters:
    `info` - the driver information
  Returns:
    Connection
  Throws:
    `SQLException`
  See Also:
    `Driver.connect(String, java.util.Properties)`

### commit

    void commit()
                throws RepositoryException

  Throws:
    `RepositoryException`
  See Also:
    `Connection.commit()`

### rollback

    void rollback()
                  throws RepositoryException

  Throws:
    `RepositoryException`
  See Also:
    `Connection.rollback()`

### isValid

    boolean isValid(int timeout)
                    throws RepositoryException

  Parameters:
    `timeout` -
  Returns:
    boolean indicating if timeout is valid
  Throws:
    `RepositoryException`
  See Also:
    `Connection.isValid(int)`

### isWrapperFor

    boolean isWrapperFor(Class<?> iface)

  Parameters:
    `iface` -
  Returns:
    boolean
  See Also:
    `Wrapper.isWrapperFor(java.lang.Class)`

### unwrap

    <T> T unwrap(Class<T> iface)
             throws SQLException

  Type Parameters:
    `T` -
  Parameters:
    `iface` -
  Returns:
    T
  Throws:
    `SQLException`
  See Also:
    `Wrapper.unwrap(java.lang.Class)`

### getRepositoryNames

    Set<String> getRepositoryNames()
                                   throws RepositoryException

  Called to get all the repository names currently available in the JcrEngine.

  Returns:
    Set of repository names
  Throws:
    `RepositoryException`

### getDescriptor

    String getDescriptor(String descriptorKey)

  Returns the value for the requested `descriptorKey`

  Parameters:
    `descriptorKey` -
  Returns:
    String descriptor value

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2008-2011 JBoss, a division of Red Hat. All Rights Reserved.