1
/*******************************************************************************
2
*Copyright (c) 2009 Eucalyptus Systems, Inc.
4
* This program is free software: you can redistribute it and/or modify
5
* it under the terms of the GNU General Public License as published by
6
* the Free Software Foundation, only version 3 of the License.
9
* This file is distributed in the hope that it will be useful, but WITHOUT
10
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14
* You should have received a copy of the GNU General Public License along
15
* with this program. If not, see <http://www.gnu.org/licenses/>.
17
* Please contact Eucalyptus Systems, Inc., 130 Castilian
18
* Dr., Goleta, CA 93101 USA or visit <http://www.eucalyptus.com/licenses/>
19
* if you need additional information or have any questions.
21
* This file may incorporate work covered under the following copyright and
24
* Software License Agreement (BSD License)
26
* Copyright (c) 2008, Regents of the University of California
27
* All rights reserved.
29
* Redistribution and use of this software in source and binary forms, with
30
* or without modification, are permitted provided that the following
33
* Redistributions of source code must retain the above copyright notice,
34
* this list of conditions and the following disclaimer.
36
* Redistributions in binary form must reproduce the above copyright
37
* notice, this list of conditions and the following disclaimer in the
38
* documentation and/or other materials provided with the distribution.
40
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
41
* IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
42
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
43
* PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
44
* OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
45
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
46
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
47
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
48
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
49
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
50
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. USERS OF
51
* THIS SOFTWARE ACKNOWLEDGE THE POSSIBLE PRESENCE OF OTHER OPEN SOURCE
52
* LICENSED MATERIAL, COPYRIGHTED MATERIAL OR PATENTED MATERIAL IN THIS
53
* SOFTWARE, AND IF ANY SUCH MATERIAL IS DISCOVERED THE PARTY DISCOVERING
54
* IT MAY INFORM DR. RICH WOLSKI AT THE UNIVERSITY OF CALIFORNIA, SANTA
55
* BARBARA WHO WILL THEN ASCERTAIN THE MOST APPROPRIATE REMEDY, WHICH IN
56
* THE REGENTS’ DISCRETION MAY INCLUDE, WITHOUT LIMITATION, REPLACEMENT
57
* OF THE CODE SO IDENTIFIED, LICENSING OF THE CODE SO IDENTIFIED, OR
58
* WITHDRAWAL OF THE CODE CAPABILITY TO THE EXTENT NEEDED TO COMPLY WITH
59
* ANY SUCH LICENSES OR RIGHTS.
60
*******************************************************************************/
65
* Author: chris grzegorczyk <grze@eucalyptus.com>
67
package com.eucalyptus.util;
69
import java.util.List;
71
import javax.persistence.EntityManager;
73
import org.apache.log4j.Logger;
74
import org.hibernate.Session;
75
import org.hibernate.criterion.Example;
76
import org.hibernate.criterion.MatchMode;
77
import org.hibernate.exception.JDBCConnectionException;
79
import com.eucalyptus.bootstrap.Component;
80
import com.google.common.collect.Lists;
81
import com.google.common.collect.Sets;
83
import edu.ucsb.eucalyptus.msgs.EventRecord;
85
public class EntityWrapper<TYPE> {
87
static Logger LOG = Logger.getLogger( EntityWrapper.class );
89
private static final boolean TRACE = "TRACE".equals( System.getProperty( "euca.log.exhaustive.db" ) );
90
public EntityWrapper( ) {
91
this( "eucalyptus_general" );
94
@SuppressWarnings( "unchecked" )
95
public EntityWrapper( String persistenceContext ) {
97
if( TRACE ) LOG.trace( EventRecord.here( Component.db, DbEvent.CREATE.begin( ) ) );
98
this.tx = new TxHandle( persistenceContext );
99
} catch ( Throwable e ) {
100
if( TRACE ) LOG.trace( EventRecord.here( Component.db, DbEvent.CREATE.fail( ),e.getMessage( ) ) );
101
this.exceptionCaught( e );
102
throw (RuntimeException) e ;
104
if( TRACE ) LOG.trace( EventRecord.here( Component.db, DbEvent.CREATE.end( ), Long.toString( tx.splitOperation() ), tx.getTxUuid( ) ) );
107
@SuppressWarnings( "unchecked" )
108
public List<TYPE> query( TYPE example ) {
109
if( TRACE ) LOG.trace( EventRecord.here( Component.db, DbEvent.QUERY.begin( ), tx.getTxUuid( ) ) );
110
Example qbe = Example.create( example ).enableLike( MatchMode.EXACT );
111
List<TYPE> resultList = ( List<TYPE> ) this.getSession( ).createCriteria( example.getClass( ) ).setCacheable( true ).add( qbe ).list( );
112
if( TRACE ) LOG.trace( EventRecord.here( Component.db, DbEvent.QUERY.end( ), Long.toString( tx.splitOperation( ) ), tx.getTxUuid( ) ) );
113
return Lists.newArrayList( Sets.newHashSet( resultList ) );
116
public TYPE getUnique( TYPE example ) throws EucalyptusCloudException {
117
if( TRACE ) LOG.trace( EventRecord.here( Component.db, DbEvent.UNIQUE.begin( ), tx.getTxUuid( ) ) );
118
List<TYPE> res = this.query( example );
119
if ( res.size( ) != 1 ) {
122
msg = LogUtil.dumpObject( example );
123
} catch ( Exception e ) {
124
msg = example.toString( );
126
if( TRACE ) LOG.trace( EventRecord.here( Component.db, DbEvent.QUERY.fail( ), Long.toString( tx.splitOperation( ) ), tx.getTxUuid( ) ) );
127
throw new EucalyptusCloudException( "Error locating information for " + msg );
129
if( TRACE ) LOG.trace( EventRecord.here( Component.db, DbEvent.QUERY.end( ), Long.toString( tx.splitOperation( ) ), tx.getTxUuid( ) ) );
133
@SuppressWarnings( "unchecked" )
134
private void exceptionCaught( Throwable e ) {
135
Throwable cause = DebugUtil.checkForCauseOfInterest( e, JDBCConnectionException.class, IllegalStateException.class );
136
if ( !( cause instanceof ExceptionNotRelatedException ) ) {
137
LOG.error( cause, cause );
138
DatabaseUtil.handleConnectionError( cause );
142
public void add( TYPE newObject ) {
143
this.getEntityManager( ).persist( newObject );
146
public void merge( TYPE newObject ) {
147
this.getEntityManager( ).merge( newObject );
150
public void mergeAndCommit( TYPE newObject ) {
151
this.getEntityManager( ).merge( newObject );
155
public void delete( TYPE deleteObject ) {
156
this.getEntityManager( ).remove( deleteObject );
159
public void rollback( ) {
160
if( TRACE ) LOG.trace( EventRecord.here( Component.db, DbEvent.ROLLBACK.begin( ), tx.getTxUuid( ) ) );
163
} catch ( Throwable e ) {
164
if( TRACE ) LOG.trace( EventRecord.here( Component.db, DbEvent.ROLLBACK.fail( ), Long.toString( tx.splitOperation() ), tx.getTxUuid( ) ) );
165
this.exceptionCaught( e );
167
if( TRACE ) LOG.trace( EventRecord.here( Component.db, DbEvent.ROLLBACK.end( ), Long.toString( tx.splitOperation() ), tx.getTxUuid( ) ) );
170
public void commit( ) {
171
if( TRACE ) LOG.trace( EventRecord.here( Component.db, DbEvent.COMMIT.begin( ), tx.getTxUuid( ) ) );
174
} catch ( Throwable e ) {
175
if( TRACE ) LOG.trace( EventRecord.here( Component.db, DbEvent.COMMIT.fail( ), Long.toString( tx.splitOperation( ) ), tx.getTxUuid( ) ) );
176
this.exceptionCaught( e );
177
throw (RuntimeException) e ;
179
if( TRACE ) LOG.trace( EventRecord.here( Component.db, DbEvent.COMMIT.end( ), Long.toString( tx.splitOperation( ) ), tx.getTxUuid( ) ) );
182
public Session getSession( ) {
183
return tx.getSession( );
186
public EntityManager getEntityManager( ) {
187
return tx.getEntityManager( );
190
@SuppressWarnings( "unchecked" )
191
public <NEWTYPE> EntityWrapper<NEWTYPE> recast( Class<NEWTYPE> c ) {
192
return ( EntityWrapper<NEWTYPE> ) this;
195
public static StackTraceElement getMyStackTraceElement( ) {
197
for ( StackTraceElement ste : Thread.currentThread( ).getStackTrace( ) ) {
198
if ( i++ < 2 || ste.getClassName( ).matches( ".*EntityWrapper.*" )
199
|| ste.getClassName( ).matches( ".*TxHandle.*" )
200
|| ste.getMethodName( ).equals( "getEntityWrapper" ) ) {
206
throw new RuntimeException( "BUG: Reached bottom of stack trace without finding any relevent frames." );
215
public String fail() {
216
return this.name( ) + ":FAIL";
218
public String begin() {
219
return this.name( ) + ":BEGIN";
221
public String end() {
222
return this.name( ) + ":END";
224
public String getMessage( ) {
225
if( DebugUtil.TRACE ) {
226
return EntityWrapper.getMyStackTraceElement( ).toString( );