com.gemstone.gemfire.cache.execute.FunctionService Maven / Gradle / Ivy
Show all versions of gemfire-core Show documentation
/*
* Copyright (c) 2010-2015 Pivotal Software, Inc. All rights reserved.
*
* 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. See accompanying
* LICENSE file.
*/
package com.gemstone.gemfire.cache.execute;
import java.util.Map;
import java.util.Properties;
import java.util.Set;
import com.gemstone.gemfire.cache.Region;
import com.gemstone.gemfire.cache.RegionService;
import com.gemstone.gemfire.cache.client.ClientCache;
import com.gemstone.gemfire.cache.client.ClientCacheFactory;
import com.gemstone.gemfire.cache.client.Pool;
import com.gemstone.gemfire.cache.execute.internal.FunctionServiceManager;
import com.gemstone.gemfire.distributed.DistributedMember;
import com.gemstone.gemfire.distributed.DistributedSystem;
import com.gemstone.gemfire.distributed.DistributedSystemDisconnectedException;
import com.gemstone.gemfire.distributed.internal.InternalDistributedSystem;
import com.gemstone.gemfire.internal.i18n.LocalizedStrings;
/**
* Provides the entry point into execution of user defined {@linkplain Function}s.
*
* Function execution provides a means to route application behaviour to {@linkplain Region data} or more
* generically to peers in a {@link DistributedSystem} or servers in a {@link Pool}.
*
*
* @author Yogesh Mahajan
* @since 6.0
*/
public final class FunctionService {
private static final FunctionServiceManager functionSvcMgr= new FunctionServiceManager();
private FunctionService() {}
/**
* Returns an {@link Execution} object that can be used to execute a data
* dependent function on the specified Region.
* When invoked from a GemFire client, the method returns an Execution
* instance that sends a message to one of the connected servers as specified
* by the {@link Pool} for the region.
* Depending on the filters setup on the {@link Execution}, the function is
* executed on all GemFire members that define the data region, or a subset of
* members. {@link Execution#withFilter(Set)}).
*
* For DistributedRegions with DataPolicy.NORMAL, it throws
* UnsupportedOperationException. For DistributedRegions with
* DataPolicy.EMPTY, execute the function on any random member which has
* DataPolicy.REPLICATE
.
* For DistributedRegions with
* DataPolicy.REPLICATE, execute the function locally. For Regions with
* DataPolicy.PARTITION, it executes on members where the data resides as
* specified by the filter.
*
* @param region
* @return Execution
* @throws FunctionException
* if the region passed in is null
* @since 6.0
*/
public static Execution onRegion(Region region) {
return functionSvcMgr.onRegion(region);
}
/**
* Returns an {@link Execution} object that can be used to execute a data
* independent function on a server in the provided {@link Pool}.
*
* If the server goes down while dispatching or executing the function, an
* Exception will be thrown.
*
* @param pool
* from which to chose a server for execution
* @return Execution
* @throws FunctionException
* if Pool instance passed in is null
* @since 6.0
*/
public static Execution onServer(Pool pool) {
return functionSvcMgr.onServer(pool);
}
/**
* Returns an {@link Execution} object that can be used to execute a data
* independent function on all the servers in the provided {@link Pool}. If
* one of the servers goes down while dispatching or executing the function on
* the server, an Exception will be thrown.
*
* @param pool
* the set of servers to execute the function
* @return Execution
* @throws FunctionException
* if Pool instance passed in is null
* @since 6.0
*/
public static Execution onServers(Pool pool) {
return functionSvcMgr.onServers(pool);
}
/**
* Returns an {@link Execution} object that can be used to execute a data
* independent function on a server that the given cache is connected to.
*
* If the server goes down while dispatching or executing the function, an
* Exception will be thrown.
*
* @param regionService
* obtained from {@link ClientCacheFactory#create}
* or {@link ClientCache#createAuthenticatedView(Properties)}.
* @return Execution
* @throws FunctionException
* if cache is null, is not on a client, or it does not have a default pool
* @since 6.5
*/
public static Execution onServer(RegionService regionService) {
return functionSvcMgr.onServer(regionService);
}
/**
* Returns an {@link Execution} object that can be used to execute a data
* independent function on all the servers that the given cache is connected to. If
* one of the servers goes down while dispatching or executing the function on
* the server, an Exception will be thrown.
*
* @param regionService
* obtained from {@link ClientCacheFactory#create}
* or {@link ClientCache#createAuthenticatedView(Properties)}.
* @return Execution
* @throws FunctionException
* if cache is null, is not on a client, or it does not have a default pool
* @since 6.5
*/
public static Execution onServers(RegionService regionService) {
return functionSvcMgr.onServers(regionService);
}
/**
* Returns an {@link Execution} object that can be used to execute a data
* independent function on a {@link DistributedMember} of the
* {@link DistributedSystem}. If the member is not found in the system, the
* function execution will throw an Exception. If the member goes down while
* dispatching or executing the function on the member, an Exception will be
* thrown.
*
* @param system
* defines the distributed system
* @param distributedMember
* defines a member in the distributed system
* @return Execution
* @throws FunctionException
* if either input parameter is null
* @since 6.0
* @deprecated use {@link #onMember(DistributedMember)} instead
*/
public static Execution onMember(DistributedSystem system,
DistributedMember distributedMember) {
return functionSvcMgr.onMember(system, distributedMember);
}
/**
* Returns an {@link Execution} object that can be used to execute a data
* independent function on all members of the {@link DistributedSystem}. If
* one of the members goes down while dispatching or executing the function on
* the member, an Exception will be thrown.
*
* @param system
* defines the distributed system
* @return Execution
*
* @throws FunctionException
* if DistributedSystem instance passed is null
* @since 6.0
* @deprecated use {@link #onMember(String...)} instead
*/
public static Execution onMembers(DistributedSystem system) {
return functionSvcMgr.onMembers(system);
}
/**
* Returns an {@link Execution} object that can be used to execute a data
* independent function on the set of {@link DistributedMember}s of the
* {@link DistributedSystem}. If one of the members goes down while
* dispatching or executing the function, an Exception will be thrown.
*
* @param system
* defines the distributed system
* @param distributedMembers
* set of distributed members on which {@link Function} to be
* executed
* @throws FunctionException
* if DistributedSystem instance passed is null
* @since 6.0
* @deprecated use {@link #onMembers(Set)} instead
*/
public static Execution onMembers(DistributedSystem system,
Set distributedMembers) {
return functionSvcMgr.onMembers(system, distributedMembers);
}
/**
* Returns an {@link Execution} object that can be used to execute a data
* independent function on a {@link DistributedMember}. If the member is not
* found, executing the function will throw an Exception. If the member goes
* down while dispatching or executing the function on the member, an
* Exception will be thrown.
*
* @param distributedMember
* defines a member in the distributed system
* @return Execution
* @throws FunctionException
* if distributedMember is null
* @since 7.0
*
*/
public static Execution onMember(DistributedMember distributedMember) {
return functionSvcMgr.onMember(getDistributedSystem(), distributedMember);
}
/**
* Returns an {@link Execution} object that can be used to execute a data
* independent function on all peer members. If the optional groups parameter
* is provided, function is executed on all members that belong to the
* provided groups.
*
* If one of the members goes down while dispatching or executing the function
* on the member, an Exception will be thrown.
*
* @param groups
* optional list of GemFire configuration property "groups" (see
* groups) on which to execute the function.
* Function will be executed on all members of each group
* @return Execution
*
* @throws FunctionException
* if no members are found belonging to the provided groups
* @since 7.0
*/
public static Execution onMembers(String... groups) {
return functionSvcMgr.onMembers(getDistributedSystem(), groups);
}
/**
* Returns an {@link Execution} object that can be used to execute a data
* independent function on the set of {@link DistributedMember}s. If one of
* the members goes down while dispatching or executing the function, an
* Exception will be thrown.
*
* @param distributedMembers
* set of distributed members on which {@link Function} to be
* executed
* @throws FunctionException
* if distributedMembers is null
* @since 7.0
*/
public static Execution onMembers(Set distributedMembers) {
return functionSvcMgr.onMembers(getDistributedSystem(), distributedMembers);
}
/**
* Returns an {@link Execution} object that can be used to execute a data
* independent function on one member of each group provided.
*
* @param groups
* list of GemFire configuration property "groups" (see
* groups) on which to execute the function.
* Function will be executed on one member of each group
*
* @return Execution
* @throws FunctionException
* if no members are found belonging to the provided groups
* @since 7.0
*/
public static Execution onMember(String... groups) {
return functionSvcMgr.onMember(getDistributedSystem(), groups);
}
/**
* Returns the {@link Function} defined by the functionId, returns null if no
* function is found for the specified functionId
*
* @param functionId
* @return Function
* @throws FunctionException
* if functionID passed is null
* @since 6.0
*/
public static Function getFunction(String functionId) {
return functionSvcMgr.getFunction(functionId);
}
/**
* Registers the given {@link Function} with the {@link FunctionService} using
* {@link Function#getId()}.
*
* Registering a function allows execution of the function using
* {@link Execution#execute(String)}. Every member that could execute a
* function using its {@link Function#getId()} should register the function.
*
*
* @throws FunctionException
* if function instance passed is null or Function.getId()
* returns null
* @since 6.0
*/
public static void registerFunction(Function function) {
functionSvcMgr.registerFunction(function);
}
/**
* Unregisters the given {@link Function} with the {@link FunctionService}
* using {@link Function#getId()}.
*
*
* @throws FunctionException
* if function instance passed is null or Function.getId()
* returns null
* @since 6.0
*/
public static void unregisterFunction(String functionId) {
functionSvcMgr.unregisterFunction(functionId);
}
/**
* Returns true if the function is registered to FunctionService
*
* @throws FunctionException
* if function instance passed is null or Function.getId()
* returns null
* @since 6.0
*/
public static boolean isRegistered(String functionId) {
return functionSvcMgr.isRegistered(functionId);
}
/**
* Returns all locally registered functions
* @return A view of registered functions as a Map
* of {@link Function#getId()} to {@link Function}
* @since 6.0
*/
public static Map getRegisteredFunctions() {
return functionSvcMgr.getRegisteredFunctions();
}
private static DistributedSystem getDistributedSystem() {
DistributedSystem system = InternalDistributedSystem.getConnectedInstance();
if (system == null) {
throw new DistributedSystemDisconnectedException(
LocalizedStrings.InternalDistributedSystem_THIS_CONNECTION_TO_A_DISTRIBUTED_SYSTEM_HAS_BEEN_DISCONNECTED
.toLocalizedString());
}
return system;
}
}