summaryrefslogtreecommitdiffstats
path: root/sandbox/old/contrib/persistence/store.jdbc/src/main/java/org/apache/tuscany/service/persistence/store/jdbc/Converter.java
blob: b37ae6cbe56896ebc9669101841304eb70712ae7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.tuscany.service.persistence.store.jdbc;

import java.io.Serializable;
import java.sql.Connection;
import java.sql.PreparedStatement;

import org.apache.tuscany.spi.services.store.StoreReadException;
import org.apache.tuscany.spi.services.store.StoreWriteException;

/**
 * Converters mediate the particularities of specific databases and JDBC drivers such as data types during read and
 * write operations
 *
 * @version $Rev$ $Date$
 */
public interface Converter {

    /**
     * Returns the SQL statement to select a record for update
     *
     * @return the SQL statement to select a record for update
     */
    String getSelectUpdateSql();

    /**
     * Returns the SQL statement to add a record
     *
     * @return the SQL statement to add a record
     */
    String getInsertSql();

    /**
     * Returns the SQL statement to update a record
     *
     * @return the SQL statement to update a record
     */
    String getUpdateSql();

    /**
     * Returns the SQL statement to retrieve a record
     *
     * @return the SQL statement to retrieve a record
     */
    String getFindSql();

    /**
     * Returns the SQL statement to remove a record
     *
     * @return the SQL statement to remove a record
     */
    String getDeleteSql();

    /**
     * Returns the SQL statement to remove expired records
     *
     * @return the SQL statement to remove expired records
     */
    String getDeleteExpiredSql();

    String getDeleteRecordSql();

    /**
     * Writes a new record to the underlying store using batch semantics. That is, the insert will be added as a batch
     * operation to the prepared statment. It is the responsibility of the client (i.e. the prepared statement "owner")
     * to exectute the statement when the batch threshold is reached. Note implementations must assume auto commit is
     * false.
     *
     * @param stmt
     * @param ownerId
     * @param id
     * @param expiration
     * @param object
     * @throws org.apache.tuscany.spi.services.store.StoreWriteException
     *
     */
    void insert(PreparedStatement stmt, String ownerId, String id, long expiration, Serializable object)
        throws StoreWriteException;

    /**
     * @param stmt
     * @param ownerId
     * @param id
     * @param object
     * @throws StoreWriteException
     */
    void update(PreparedStatement stmt, String ownerId, String id, Serializable object) throws StoreWriteException;

    /**
     * @param stmt
     * @param ownerId
     * @param id
     * @return
     * @throws StoreWriteException
     */
    boolean findAndLock(PreparedStatement stmt, String ownerId, String id) throws StoreWriteException;

    /**
     * Reads a record from the underlying store. Note implementations must assume auto commit is false.
     *
     * @param conn
     * @param ownerId
     * @param id
     * @return
     * @throws StoreReadException
     */
    Object read(Connection conn, String ownerId, String id) throws StoreReadException;

    /**
     * @param stmt
     * @param ownerId
     * @param id
     * @throws StoreWriteException
     */
    void delete(PreparedStatement stmt, String ownerId, String id) throws StoreWriteException;

}