| /* |
| * 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.geode.internal.cache.tier.sockets.command; |
| |
| import java.io.IOException; |
| import java.util.ArrayList; |
| import java.util.List; |
| |
| import org.apache.geode.annotations.Immutable; |
| import org.apache.geode.cache.DynamicRegionFactory; |
| import org.apache.geode.cache.InterestResultPolicy; |
| import org.apache.geode.cache.operations.RegisterInterestOperationContext; |
| import org.apache.geode.internal.cache.LocalRegion; |
| import org.apache.geode.internal.cache.tier.Command; |
| import org.apache.geode.internal.cache.tier.InterestType; |
| import org.apache.geode.internal.cache.tier.MessageType; |
| import org.apache.geode.internal.cache.tier.sockets.BaseCommand; |
| import org.apache.geode.internal.cache.tier.sockets.CacheClientProxy; |
| import org.apache.geode.internal.cache.tier.sockets.ChunkedMessage; |
| import org.apache.geode.internal.cache.tier.sockets.Message; |
| import org.apache.geode.internal.cache.tier.sockets.Part; |
| import org.apache.geode.internal.cache.tier.sockets.ServerConnection; |
| import org.apache.geode.internal.security.AuthorizeRequest; |
| import org.apache.geode.internal.security.SecurityService; |
| import org.apache.geode.security.ResourcePermission.Operation; |
| import org.apache.geode.security.ResourcePermission.Resource; |
| |
| public class RegisterInterestList extends BaseCommand { |
| |
| @Immutable |
| private static final RegisterInterestList singleton = new RegisterInterestList(); |
| |
| public static Command getCommand() { |
| return singleton; |
| } |
| |
| RegisterInterestList() {} |
| |
| @Override |
| public void cmdExecute(Message clientMessage, ServerConnection serverConnection, |
| SecurityService securityService, long start) throws IOException, InterruptedException { |
| Part regionNamePart, keyPart, numberOfKeysPart; |
| String regionName; |
| Object key = null; |
| InterestResultPolicy policy; |
| List<Object> keys; |
| int numberOfKeys, partNumber; |
| serverConnection.setAsTrue(REQUIRES_RESPONSE); |
| serverConnection.setAsTrue(REQUIRES_CHUNKED_RESPONSE); |
| ChunkedMessage chunkedResponseMsg = serverConnection.getRegisterInterestResponseMessage(); |
| |
| regionNamePart = clientMessage.getPart(0); |
| regionName = regionNamePart.getCachedString(); |
| |
| // Retrieve the InterestResultPolicy |
| try { |
| policy = (InterestResultPolicy) clientMessage.getPart(1).getObject(); |
| } catch (Exception e) { |
| writeChunkedException(clientMessage, e, serverConnection); |
| serverConnection.setAsTrue(RESPONDED); |
| return; |
| } |
| boolean isDurable; |
| try { |
| Part durablePart = clientMessage.getPart(2); |
| byte[] durablePartBytes = (byte[]) durablePart.getObject(); |
| isDurable = durablePartBytes[0] == 0x01; |
| } catch (Exception e) { |
| writeChunkedException(clientMessage, e, serverConnection); |
| serverConnection.setAsTrue(RESPONDED); |
| return; |
| } |
| numberOfKeysPart = clientMessage.getPart(3); |
| numberOfKeys = numberOfKeysPart.getInt(); |
| |
| partNumber = 4; |
| keys = new ArrayList<>(); |
| for (int i = 0; i < numberOfKeys; i++) { |
| keyPart = clientMessage.getPart(partNumber + i); |
| try { |
| key = keyPart.getStringOrObject(); |
| } catch (Exception e) { |
| writeChunkedException(clientMessage, e, serverConnection); |
| serverConnection.setAsTrue(RESPONDED); |
| return; |
| } |
| keys.add(key); |
| } |
| |
| boolean sendUpdatesAsInvalidates = false; |
| |
| // VJR: Check for an extra part for client version 6.0.3 onwards for the |
| // time being until refactoring into a new command version. |
| if (clientMessage.getNumberOfParts() > (numberOfKeys + partNumber)) { |
| try { |
| Part notifyPart = clientMessage.getPart(numberOfKeys + partNumber); |
| byte[] notifyPartBytes = (byte[]) notifyPart.getObject(); |
| sendUpdatesAsInvalidates = notifyPartBytes[0] == 0x01; |
| } catch (Exception e) { |
| writeChunkedException(clientMessage, e, serverConnection); |
| serverConnection.setAsTrue(RESPONDED); |
| return; |
| } |
| } |
| |
| if (logger.isDebugEnabled()) { |
| logger.debug( |
| "{}: Received register interest request ({} bytes) from {} for the following {} keys in region {}: {}", |
| serverConnection.getName(), clientMessage.getPayloadLength(), |
| serverConnection.getSocketString(), numberOfKeys, regionName, keys); |
| } |
| |
| // Process the register interest request |
| if (keys.isEmpty() || regionName == null) { |
| String errMessage = null; |
| if (keys.isEmpty() && regionName == null) { |
| errMessage = |
| "The input list of keys is empty and the input region name is null for the register interest request."; |
| } else if (keys.isEmpty()) { |
| errMessage = |
| "The input list of keys for the register interest request is empty."; |
| } else if (regionName == null) { |
| errMessage = |
| "The input region name for the register interest request is null."; |
| } |
| logger.warn("{}: {}", serverConnection.getName(), errMessage); |
| writeChunkedErrorResponse(clientMessage, MessageType.REGISTER_INTEREST_DATA_ERROR, errMessage, |
| serverConnection); |
| serverConnection.setAsTrue(RESPONDED); |
| return; |
| } |
| |
| LocalRegion region = (LocalRegion) serverConnection.getCache().getRegion(regionName); |
| if (region == null) { |
| logger.info("{}: Region named {} was not found during register interest list request.", |
| new Object[] {serverConnection.getName(), regionName}); |
| } |
| try { |
| securityService.authorize(Resource.DATA, Operation.READ, regionName); |
| AuthorizeRequest authorizeRequest = serverConnection.getAuthzRequest(); |
| if (authorizeRequest != null) { |
| if (!DynamicRegionFactory.regionIsDynamicRegionList(regionName)) { |
| RegisterInterestOperationContext registerContext = |
| authorizeRequest.registerInterestListAuthorize(regionName, keys, policy); |
| keys = (List<Object>) registerContext.getKey(); |
| } |
| } |
| // Register interest |
| serverConnection.getAcceptor().getCacheClientNotifier().registerClientInterest(regionName, |
| keys, serverConnection.getProxyID(), isDurable, sendUpdatesAsInvalidates, false, 0, true); |
| } catch (Exception ex) { |
| // If an interrupted exception is thrown , rethrow it |
| checkForInterrupt(serverConnection, ex); |
| // Otherwise, write an exception message and continue |
| writeChunkedException(clientMessage, ex, serverConnection); |
| serverConnection.setAsTrue(RESPONDED); |
| return; |
| } |
| |
| |
| CacheClientProxy ccp = serverConnection.getAcceptor().getCacheClientNotifier() |
| .getClientProxy(serverConnection.getProxyID()); |
| |
| if (ccp == null) { |
| IOException ioException = new IOException( |
| "CacheClientProxy for this client is no longer on the server"); |
| writeChunkedException(clientMessage, ioException, serverConnection); |
| serverConnection.setAsTrue(RESPONDED); |
| return; |
| } |
| |
| boolean isPrimary = ccp.isPrimary(); |
| |
| if (!isPrimary) { |
| chunkedResponseMsg.setMessageType(MessageType.RESPONSE_FROM_SECONDARY); |
| chunkedResponseMsg.setTransactionId(clientMessage.getTransactionId()); |
| chunkedResponseMsg.sendHeader(); |
| chunkedResponseMsg.setLastChunk(true); |
| if (logger.isDebugEnabled()) { |
| logger.debug( |
| "{}: Sending register interest response chunk from secondary for region: {} for key: {} chunk=<{}>", |
| serverConnection.getName(), regionName, key, chunkedResponseMsg); |
| } |
| chunkedResponseMsg.sendChunk(serverConnection); |
| } else { // isPrimary |
| // Send header which describes how many chunks will follow |
| chunkedResponseMsg.setMessageType(MessageType.RESPONSE_FROM_PRIMARY); |
| chunkedResponseMsg.setTransactionId(clientMessage.getTransactionId()); |
| chunkedResponseMsg.sendHeader(); |
| |
| // Send chunk response |
| try { |
| fillAndSendRegisterInterestResponseChunks(region, keys, InterestType.KEY, policy, |
| serverConnection); |
| serverConnection.setAsTrue(RESPONDED); |
| } catch (Exception e) { |
| checkForInterrupt(serverConnection, e); |
| writeChunkedException(clientMessage, e, serverConnection); |
| serverConnection.setAsTrue(RESPONDED); |
| return; |
| } |
| |
| if (logger.isDebugEnabled()) { |
| logger.debug( |
| "{}: Sent register interest response for the following {} keys in region {}: {}", |
| serverConnection.getName(), numberOfKeys, regionName, keys); |
| } |
| |
| } // isPrimary |
| } |
| |
| } |
