/*
    * Copyright 2002-2012 the original author or authors.
    *
    * Licensed 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.springframework.orm.hibernate3.support;
  
  import java.sql.PreparedStatement;
  import java.sql.ResultSet;
  import java.sql.SQLException;
  import java.sql.Types;
  import java.util.Arrays;
  import javax.transaction.TransactionManager;
  
  import org.springframework.jdbc.support.lob.LobCreator;
  import org.springframework.jdbc.support.lob.LobHandler;
  
  /**
   * Hibernate UserType implementation for byte arrays that get mapped to BLOBs.
   * Retrieves the LobHandler to use from LocalSessionFactoryBean at config time.
   *
   * <p>Can also be defined in generic Hibernate mappings, as DefaultLobCreator will
   * work with most JDBC-compliant database drivers. In this case, the field type
   * does not have to be BLOB: For databases like MySQL and MS SQL Server, any
   * large enough binary type will work.
   *
   * @author Juergen Hoeller
   * @since 1.2
   * @see org.springframework.orm.hibernate3.LocalSessionFactoryBean#setLobHandler
   */
  public class BlobByteArrayType extends AbstractLobType  {
  
  	/**
  	 * Constructor used by Hibernate: fetches config-time LobHandler and
  	 * config-time JTA TransactionManager from LocalSessionFactoryBean.
  	 * @see org.springframework.orm.hibernate3.LocalSessionFactoryBean#getConfigTimeLobHandler
  	 * @see org.springframework.orm.hibernate3.LocalSessionFactoryBean#getConfigTimeTransactionManager
  	 */
  	public BlobByteArrayType() {
  		super();
  	}
  
  	/**
  	 * Constructor used for testing: takes an explicit LobHandler
  	 * and an explicit JTA TransactionManager (can be {@code null}).
  	 */
  	protected BlobByteArrayType(LobHandler lobHandler, TransactionManager jtaTransactionManager) {
  		super(lobHandler, jtaTransactionManager);
  	}
  
  	@Override
  	public int[] sqlTypes() {
  		return new int[] {Types.BLOB};
  	}
  
  	@Override
  	public Class<?> returnedClass() {
  		return byte[].class;
  	}
  
  	@Override
  	public boolean isMutable() {
  		return true;
  	}
  
  	@Override
  	public boolean equals(Object x, Object y) {
  		return (x == y) ||
  				(x instanceof byte[] && y instanceof byte[] && Arrays.equals((byte[]) x, (byte[]) y));
  	}
  
  	@Override
  	public Object deepCopy(Object value) {
  		if (value == null) {
  			return null;
  		}
  		byte[] original = (byte[]) value;
  		byte[] copy = new byte[original.length];
  		System.arraycopy(original, 0, copy, 0, original.length);
  		return copy;
  	}
  
  	@Override
  	protected Object nullSafeGetInternal(
  			ResultSet rs, String[] names, Object owner, LobHandler lobHandler)
  			throws SQLException {
  
  		return lobHandler.getBlobAsBytes(rs, names[0]);
 	}
 
 	@Override
 	protected void nullSafeSetInternal(
 			PreparedStatement ps, int index, Object value, LobCreator lobCreator)
 			throws SQLException {
 
 		lobCreator.setBlobAsBytes(ps, index, (byte[]) value);
 	}
 
 }