| /*========================================================================= |
| * Copyright (c) 2002-2014 Pivotal Software, Inc. All Rights Reserved. |
| * This product is protected by U.S. and international copyright |
| * and intellectual property laws. Pivotal products are covered by |
| * more patents listed at http://www.pivotal.io/patents. |
| *========================================================================= |
| */ |
| package com.gemstone.gemfire.cache.client.internal; |
| |
| import com.gemstone.gemfire.DataSerializer; |
| import com.gemstone.gemfire.InternalGemFireError; |
| import com.gemstone.gemfire.cache.Operation; |
| import com.gemstone.gemfire.cache.Region; |
| import com.gemstone.gemfire.cache.client.AllConnectionsInUseException; |
| import com.gemstone.gemfire.cache.client.ServerConnectivityException; |
| import com.gemstone.gemfire.cache.client.ServerOperationException; |
| import com.gemstone.gemfire.cache.util.BridgeWriterException; |
| import com.gemstone.gemfire.distributed.internal.ServerLocation; |
| import com.gemstone.gemfire.distributed.internal.membership.InternalDistributedMember; |
| import com.gemstone.gemfire.internal.cache.CachedDeserializable; |
| import com.gemstone.gemfire.internal.cache.EntryEventImpl; |
| import com.gemstone.gemfire.internal.cache.LocalRegion; |
| import com.gemstone.gemfire.internal.cache.tier.MessageType; |
| import com.gemstone.gemfire.internal.cache.tier.sockets.ChunkedMessage; |
| import com.gemstone.gemfire.internal.cache.tier.sockets.Message; |
| import com.gemstone.gemfire.internal.cache.tier.sockets.Part; |
| import com.gemstone.gemfire.internal.cache.versions.VersionTag; |
| import com.gemstone.gemfire.internal.logging.LogService; |
| import com.gemstone.gemfire.internal.offheap.StoredObject; |
| |
| import java.io.ByteArrayInputStream; |
| import java.io.DataInputStream; |
| |
| import org.apache.logging.log4j.Logger; |
| |
| /** |
| * Does a region put (or create) on a server |
| * @author darrel |
| * @since 5.7 |
| */ |
| public class PutOp { |
| |
| private static final Logger logger = LogService.getLogger(); |
| |
| /** |
| * Does a region put on a server using connections from the given pool |
| * to communicate with the server. |
| * @param pool the pool to use to communicate with the server. |
| * @param region the region to do the put on |
| * @param key the entry key to do the put on |
| * @param value the entry value to put |
| * @param event the event for this put |
| * @param requireOldValue |
| * @param expectedOldValue |
| * @param callbackArg an optional callback arg to pass to any cache callbacks |
| */ |
| public static Object execute(ExecutablePool pool, |
| LocalRegion region, |
| Object key, |
| Object value, |
| byte[] deltaBytes, |
| EntryEventImpl event, |
| Operation operation, |
| boolean requireOldValue, Object expectedOldValue, |
| Object callbackArg, |
| boolean prSingleHopEnabled) |
| { |
| AbstractOp op = new PutOpImpl(region, key, value, deltaBytes, event, |
| operation, requireOldValue, |
| expectedOldValue, callbackArg, |
| false/*donot send full obj; send delta*/, prSingleHopEnabled); |
| |
| if (prSingleHopEnabled) { |
| ClientMetadataService cms = region.getCache().getClientMetadataService(); |
| ServerLocation server = cms.getBucketServerLocation(region, |
| Operation.UPDATE, key, value, callbackArg); |
| if (server != null) { |
| try { |
| PoolImpl poolImpl = (PoolImpl)pool; |
| boolean onlyUseExistingCnx = ((poolImpl.getMaxConnections() != -1 && poolImpl |
| .getConnectionCount() >= poolImpl.getMaxConnections()) ? true |
| : false); |
| return pool.executeOn(new ServerLocation(server.getHostName(), server |
| .getPort()), op, true, onlyUseExistingCnx); |
| } |
| catch (AllConnectionsInUseException e) { |
| } |
| catch (ServerConnectivityException e) { |
| if (e instanceof ServerOperationException) { |
| throw e; // fixed 44656 |
| } |
| cms.removeBucketServerLocation(server); |
| } |
| catch (BridgeWriterException e) { |
| if (e.getCause() instanceof ServerConnectivityException) |
| cms.removeBucketServerLocation(server); |
| } |
| } |
| } |
| return pool.execute(op); |
| } |
| |
| public static Object execute(ExecutablePool pool, String regionName, |
| Object key, Object value, byte[] deltaBytes, EntryEventImpl event, Operation operation, |
| boolean requireOldValue, Object expectedOldValue, |
| Object callbackArg, boolean prSingleHopEnabled, boolean isMetaRegionPutOp) { |
| AbstractOp op = new PutOpImpl(regionName, key, value, deltaBytes, event, |
| operation, requireOldValue, |
| expectedOldValue, callbackArg, |
| false/*donot send full obj; send delta*/, prSingleHopEnabled); |
| ((PutOpImpl)op).setMetaRegionPutOp(isMetaRegionPutOp); |
| return pool.execute(op); |
| } |
| |
| |
| /** |
| * This is a unit test method. |
| * It does a region put on a server using the given connection from the given pool |
| * to communicate with the server. Do not call this method if the value is |
| * Delta instance. |
| * @param con the connection to use |
| * @param pool the pool to use to communicate with the server. |
| * @param regionName the name of the region to do the put on |
| * @param key the entry key to do the put on |
| * @param value the entry value to put |
| * @param event the event for this put |
| * @param callbackArg an optional callback arg to pass to any cache callbacks |
| */ |
| public static void execute(Connection con, |
| ExecutablePool pool, |
| String regionName, |
| Object key, |
| Object value, |
| EntryEventImpl event, |
| Object callbackArg, |
| boolean prSingleHopEnabled) |
| { |
| AbstractOp op = new PutOpImpl(regionName, key, value, null, |
| event, Operation.CREATE, false, |
| null, callbackArg, false /*donot send full Obj; send delta*/, prSingleHopEnabled); |
| pool.executeOn(con, op); |
| } |
| |
| public static final byte HAS_OLD_VALUE_FLAG = 0x01; |
| public static final byte OLD_VALUE_IS_OBJECT_FLAG = 0x02; |
| public static final byte HAS_VERSION_TAG = 0x04; |
| |
| private PutOp() { |
| // no instances allowed |
| } |
| |
| private static class PutOpImpl extends AbstractOp { |
| |
| private Object key; |
| |
| |
| private LocalRegion region; |
| |
| /** |
| * the operation will have either a region or a regionName. Names seem |
| * to be used by unit tests to exercise operations without creating a |
| * real region |
| */ |
| private String regionName; |
| |
| private Object value; |
| |
| private boolean deltaSent = false; |
| |
| private EntryEventImpl event; |
| |
| private Object callbackArg; |
| |
| private boolean isMetaRegionPutOp; |
| |
| private boolean prSingleHopEnabled; |
| |
| private boolean requireOldValue; |
| |
| private Object expectedOldValue; |
| |
| public PutOpImpl(String regionName , Object key, Object value, byte[] deltaBytes, |
| EntryEventImpl event, |
| Operation op, boolean requireOldValue, |
| Object expectedOldValue, Object callbackArg, |
| boolean sendFullObj, boolean prSingleHopEnabled) { |
| super(MessageType.PUT, 7 + (callbackArg != null? 1:0) + (expectedOldValue != null? 1:0)); |
| final boolean isDebugEnabled = logger.isDebugEnabled(); |
| if (isDebugEnabled) { |
| logger.debug("PutOpImpl constructing(1) message for {}; operation={}", event.getEventId(), op); |
| } |
| this.key = key; |
| this.callbackArg = callbackArg; |
| this.event = event; |
| this.value = value; |
| this.regionName = regionName; |
| this.prSingleHopEnabled = prSingleHopEnabled; |
| this.requireOldValue = requireOldValue; |
| this.expectedOldValue = expectedOldValue; |
| getMessage().addStringPart(regionName); |
| getMessage().addObjPart(op); |
| int flags = 0; |
| if (requireOldValue) flags |= 0x01; |
| if (expectedOldValue != null) flags |= 0x02; |
| getMessage().addIntPart(flags); |
| if (expectedOldValue != null) { |
| getMessage().addObjPart(expectedOldValue); |
| } |
| getMessage().addStringOrObjPart(key); |
| // Add message part for sending either delta or full value |
| if (!sendFullObj && deltaBytes != null && op == Operation.UPDATE) { |
| getMessage().addObjPart(Boolean.TRUE); |
| getMessage().addBytesPart(deltaBytes); |
| this.deltaSent = true; |
| if (isDebugEnabled) { |
| logger.debug("PutOp: Sending delta for key {}", this.key); |
| } |
| } |
| else if (value instanceof CachedDeserializable) { |
| if (value instanceof StoredObject && !((StoredObject) value).isSerialized()) { |
| // it is a byte[] |
| getMessage().addObjPart(Boolean.FALSE); |
| getMessage().addObjPart(((StoredObject) value).getDeserializedForReading()); |
| } else { |
| getMessage().addObjPart(Boolean.FALSE); |
| Object cdValue = ((CachedDeserializable)value).getValue(); |
| if (cdValue instanceof byte[]) { |
| getMessage().addRawPart((byte[])cdValue, true); |
| } |
| else { |
| getMessage().addObjPart(cdValue); |
| } |
| } |
| } |
| else { |
| getMessage().addObjPart(Boolean.FALSE); |
| getMessage().addObjPart(value); |
| } |
| getMessage().addBytesPart(event.getEventId().calcBytes()); |
| if (callbackArg != null) { |
| getMessage().addObjPart(callbackArg); |
| } |
| } |
| |
| public PutOpImpl(Region region, Object key, Object value, byte[] deltaBytes, |
| EntryEventImpl event, |
| Operation op, boolean requireOldValue, |
| Object expectedOldValue, Object callbackArg, |
| boolean sendFullObj, boolean prSingleHopEnabled) { |
| super(MessageType.PUT, 7 + (callbackArg != null? 1:0) + (expectedOldValue != null? 1:0)); |
| this.key = key; |
| this.callbackArg = callbackArg; |
| this.event = event; |
| this.value = value; |
| this.region = (LocalRegion)region; |
| this.regionName = region.getFullPath(); |
| this.prSingleHopEnabled = prSingleHopEnabled; |
| final boolean isDebugEnabled = logger.isDebugEnabled(); |
| if (isDebugEnabled) { |
| logger.debug("PutOpImpl constructing message with operation={}", op); |
| } |
| getMessage().addStringPart(region.getFullPath()); |
| getMessage().addObjPart(op); |
| int flags = 0; |
| if (requireOldValue) flags |= 0x01; |
| if (expectedOldValue != null) flags |= 0x02; |
| getMessage().addIntPart(flags); |
| if (expectedOldValue != null) { |
| getMessage().addObjPart(expectedOldValue); |
| } |
| getMessage().addStringOrObjPart(key); |
| // Add message part for sending either delta or full value |
| if (!sendFullObj && deltaBytes != null && op == Operation.UPDATE) { |
| getMessage().addObjPart(Boolean.TRUE); |
| getMessage().addBytesPart(deltaBytes); |
| this.deltaSent = true; |
| if (isDebugEnabled) { |
| logger.debug("PutOp: Sending delta for key {}", this.key); |
| } |
| } |
| else if (value instanceof CachedDeserializable) { |
| if (value instanceof StoredObject && !((StoredObject) value).isSerialized()) { |
| // it is a byte[] |
| getMessage().addObjPart(Boolean.FALSE); |
| getMessage().addObjPart(((StoredObject) value).getDeserializedForReading()); |
| } else { |
| getMessage().addObjPart(Boolean.FALSE); |
| Object cdValue = ((CachedDeserializable)value).getValue(); |
| if (cdValue instanceof byte[]) { |
| getMessage().addRawPart((byte[])cdValue, true); |
| } |
| else { |
| getMessage().addObjPart(cdValue); |
| } |
| } |
| } |
| else { |
| getMessage().addObjPart(Boolean.FALSE); |
| getMessage().addObjPart(value); |
| } |
| getMessage().addBytesPart(event.getEventId().calcBytes()); |
| if (callbackArg != null) { |
| getMessage().addObjPart(callbackArg); |
| } |
| } |
| |
| @Override |
| protected Object processResponse(Message msg) throws Exception { |
| throw new UnsupportedOperationException("processResponse should not be invoked in PutOp. Use processResponse(Message, Connection)"); |
| // processAck(msg, "put"); |
| // if (prSingleHopEnabled) { |
| // byte version = 0; |
| // Part part = msg.getPart(0); |
| // byte[] bytesReceived = part.getSerializedForm(); |
| // if (bytesReceived[0] != ClientMetadataService.INITIAL_VERSION |
| // && bytesReceived.length == ClientMetadataService.SIZE_BYTES_ARRAY_RECEIVED) { // nw hop |
| // if (this.region != null) { |
| // ClientMetadataService cms; |
| // try { |
| // cms = region.getCache().getClientMetadataService(); |
| // version = cms.getMetaDataVersion(region, Operation.UPDATE, |
| // key, value, callbackArg); |
| // } |
| // catch (CacheClosedException e) { |
| // return null; |
| // } |
| // if (bytesReceived[0] != version) { |
| // cms.scheduleGetPRMetaData(region, false,bytesReceived[1]); |
| // } |
| // } |
| // } |
| // } |
| // return null; |
| } |
| |
| /* |
| * Process a response that contains an ack. |
| * |
| * @param msg |
| * the message containing the response |
| * @param con |
| * Connection on which this op is executing |
| * @throws Exception |
| * if response could not be processed or we received a |
| * response with a server exception. |
| * @since 6.1 |
| */ |
| @Override |
| protected Object processResponse(Message msg, Connection con) |
| throws Exception { |
| processAck(msg, "put", con); |
| byte version = 0 ; |
| if (prSingleHopEnabled) { |
| Part part = msg.getPart(0); |
| byte[] bytesReceived = part.getSerializedForm(); |
| if (bytesReceived[0] != ClientMetadataService.INITIAL_VERSION |
| && bytesReceived.length == ClientMetadataService.SIZE_BYTES_ARRAY_RECEIVED) { |
| if (this.region != null) { |
| ClientMetadataService cms; |
| cms = region.getCache().getClientMetadataService(); |
| version = cms.getMetaDataVersion(region, Operation.UPDATE, |
| key, value, callbackArg); |
| if (bytesReceived[0] != version) { |
| cms.scheduleGetPRMetaData(region, false, bytesReceived[1]); |
| } |
| } |
| } |
| } |
| if (msg.getMessageType() == MessageType.REPLY |
| && msg.getNumberOfParts() > 1) { |
| int flags = msg.getPart(1).getInt(); |
| int partIdx = 2; |
| Object oldValue = null; |
| if ((flags & HAS_OLD_VALUE_FLAG) != 0) { |
| oldValue = msg.getPart(partIdx++).getObject(); |
| if ((flags & OLD_VALUE_IS_OBJECT_FLAG) != 0 && oldValue instanceof byte[]) { |
| ByteArrayInputStream in = new ByteArrayInputStream((byte[])oldValue); |
| DataInputStream din = new DataInputStream(in); |
| oldValue = DataSerializer.readObject(din); |
| } |
| // if (lw.fineEnabled()) { |
| // lw.fine("read old value from server response: " + oldValue); |
| // } |
| } |
| // if the server has versioning we will attach it to the client's event |
| // here so it can be applied to the cache |
| if ((flags & HAS_VERSION_TAG) != 0) { |
| VersionTag tag = (VersionTag)msg.getPart(partIdx++).getObject(); |
| // we use the client's ID since we apparently don't track the server's ID in connections |
| tag.replaceNullIDs((InternalDistributedMember) con.getEndpoint().getMemberId()); |
| this.event.setVersionTag(tag); |
| } |
| return oldValue; |
| } |
| return null; |
| } |
| |
| /** |
| * Process a response that contains an ack. |
| * |
| * @param msg |
| * the message containing the response |
| * @param opName |
| * text describing this op |
| * @param con |
| * Connection on which this op is executing |
| * @throws Exception |
| * if response could not be processed or we received a |
| * response with a server exception. |
| * @since 6.1 |
| */ |
| private final void processAck(Message msg, String opName, Connection con) |
| throws Exception |
| { |
| final int msgType = msg.getMessageType(); |
| // Update delta stats |
| if (this.deltaSent && this.region != null) { |
| this.region.getCachePerfStats().incDeltasSent(); |
| } |
| if (msgType == MessageType.REPLY) { |
| return; |
| } |
| else { |
| Part part = msg.getPart(0); |
| if (msgType == MessageType.PUT_DELTA_ERROR) { |
| if (logger.isDebugEnabled()) { |
| logger.debug("PutOp: Sending full value as delta failed on server..."); |
| } |
| AbstractOp op = new PutOpImpl(this.regionName, this.key, this.value, |
| null, this.event, Operation.CREATE, this.requireOldValue, |
| this.expectedOldValue, this.callbackArg, |
| true /* send full obj */, this.prSingleHopEnabled); |
| |
| op.attempt(con); |
| if (this.region != null) { |
| this.region.getCachePerfStats().incDeltaFullValuesSent(); |
| } |
| } |
| else if (msgType == MessageType.EXCEPTION) { |
| String s = ": While performing a remote " + opName; |
| throw new ServerOperationException(s, (Throwable)part.getObject()); |
| // Get the exception toString part. |
| // This was added for c++ thin client and not used in java |
| // Part exceptionToStringPart = msg.getPart(1); |
| } |
| else if (isErrorResponse(msgType)) { |
| throw new ServerOperationException(part.getString()); |
| } |
| else { |
| throw new InternalGemFireError("Unexpected message type " |
| + MessageType.getString(msgType)); |
| } |
| } |
| } |
| |
| @Override |
| protected void sendMessage(Connection cnx) throws Exception { |
| if (!this.isMetaRegionPutOp) { |
| super.sendMessage(cnx); |
| } else { |
| getMessage().send(false); |
| } |
| } |
| |
| @Override |
| protected void processSecureBytes(Connection cnx, Message message) |
| throws Exception { |
| if (!this.isMetaRegionPutOp) { |
| super.processSecureBytes(cnx, message); |
| } |
| } |
| |
| @Override |
| protected boolean needsUserId() { |
| boolean ret = this.isMetaRegionPutOp ? false : super.needsUserId(); |
| return ret; |
| } |
| |
| @Override |
| protected boolean isErrorResponse(int msgType) { |
| return msgType == MessageType.PUT_DATA_ERROR; |
| } |
| |
| @Override |
| protected long startAttempt(ConnectionStats stats) { |
| return stats.startPut(); |
| } |
| @Override |
| protected void endSendAttempt(ConnectionStats stats, long start) { |
| stats.endPutSend(start, hasFailed()); |
| } |
| @Override |
| protected void endAttempt(ConnectionStats stats, long start) { |
| stats.endPut(start, hasTimedOut(), hasFailed()); |
| } |
| |
| @Override |
| public String toString() { |
| return "PutOp:"+key; |
| } |
| |
| /** |
| * Attempts to read a response to this operation by reading it from the given |
| * connection, and returning it. |
| * |
| * @param cnx |
| * the connection to read the response from |
| * @return the result of the operation or |
| * <code>null</code if the operation has no result. |
| * @throws Exception if the execute failed |
| */ |
| @Override |
| protected Object attemptReadResponse(Connection cnx) throws Exception |
| { |
| Message msg = createResponseMessage(); |
| if (msg != null) { |
| msg.setComms(cnx.getSocket(), cnx.getInputStream(), cnx |
| .getOutputStream(), cnx.getCommBuffer(), cnx.getStats()); |
| if (msg instanceof ChunkedMessage) { |
| try { |
| return processResponse(msg, cnx); |
| } |
| finally { |
| msg.unsetComms(); |
| processSecureBytes(cnx, msg); |
| } |
| } |
| else { |
| try { |
| msg.recv(); |
| } |
| finally { |
| msg.unsetComms(); |
| processSecureBytes(cnx, msg); |
| } |
| return processResponse(msg, cnx); |
| } |
| } |
| else { |
| return null; |
| } |
| } |
| |
| void setMetaRegionPutOp(boolean bool) { |
| this.isMetaRegionPutOp = bool; |
| } |
| } |
| |
| } |
