Java tutorial
/* * Copyright 2016-2017 Crown Copyright * * 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 uk.gov.gchq.gaffer.rest.service; import com.fasterxml.jackson.databind.BeanDescription; import com.fasterxml.jackson.databind.JavaType; import com.fasterxml.jackson.databind.ObjectMapper; import com.fasterxml.jackson.databind.introspect.BeanPropertyDefinition; import edu.umd.cs.findbugs.annotations.SuppressFBWarnings; import org.apache.commons.lang.StringUtils; import org.reflections.Reflections; import org.reflections.util.ClasspathHelper; import uk.gov.gchq.gaffer.data.generator.ElementGenerator; import uk.gov.gchq.gaffer.function.FilterFunction; import uk.gov.gchq.gaffer.function.TransformFunction; import uk.gov.gchq.gaffer.rest.SystemProperty; import uk.gov.gchq.gaffer.rest.factory.GraphFactory; import uk.gov.gchq.gaffer.rest.factory.UserFactory; import uk.gov.gchq.gaffer.store.StoreTrait; import uk.gov.gchq.gaffer.store.schema.Schema; import javax.inject.Inject; import java.lang.reflect.Modifier; import java.net.URL; import java.util.Collection; import java.util.HashSet; import java.util.Iterator; import java.util.List; import java.util.Set; /** * An implementation of {@link uk.gov.gchq.gaffer.rest.service.IGraphConfigurationService}. By default it will use a singleton * {@link uk.gov.gchq.gaffer.graph.Graph} generated using the {@link uk.gov.gchq.gaffer.rest.factory.GraphFactory}. * <p> * Currently the {@link uk.gov.gchq.gaffer.operation.Operation}s, {@link uk.gov.gchq.gaffer.function.FilterFunction}s, * {@link uk.gov.gchq.gaffer.function.TransformFunction}s and {@link uk.gov.gchq.gaffer.data.generator.ElementGenerator}s available * are only returned if they are in a package prefixed with 'gaffer'. */ public class GraphConfigurationService implements IGraphConfigurationService { private static final Set<Class> FILTER_FUNCTIONS = getSubClasses(FilterFunction.class); private static final Set<Class> TRANSFORM_FUNCTIONS = getSubClasses(TransformFunction.class); private static final Set<Class> GENERATORS = getSubClasses(ElementGenerator.class); @Inject private GraphFactory graphFactory; @Inject private UserFactory userFactory; public static void initialise() { // Invoking this method will cause the static lists to be populated. } @Override public Schema getSchema() { return graphFactory.getGraph().getSchema(); } @Override public Set<Class> getFilterFunctions() { return FILTER_FUNCTIONS; } @SuppressFBWarnings(value = "REC_CATCH_EXCEPTION", justification = "Need to wrap all runtime exceptions before they are given to the user") @Override public Set<Class> getFilterFunctions(final String inputClass) { if (StringUtils.isEmpty(inputClass)) { return getFilterFunctions(); } final Class<?> clazz; try { clazz = Class.forName(inputClass); } catch (final Exception e) { throw new IllegalArgumentException("Input class was not recognised: " + inputClass, e); } final Set<Class> classes = new HashSet<>(); for (final Class functionClass : FILTER_FUNCTIONS) { try { final FilterFunction function = (FilterFunction) functionClass.newInstance(); final Class<?>[] inputs = function.getInputClasses(); if (inputs.length == 1 && inputs[0].isAssignableFrom(clazz)) { classes.add(functionClass); } } catch (final Exception e) { // just add the function. classes.add(functionClass); } } return classes; } @SuppressFBWarnings(value = "REC_CATCH_EXCEPTION", justification = "Need to wrap all runtime exceptions before they are given to the user") @Override public Set<String> getSerialisedFields(final String className) { final Class<?> clazz; try { clazz = Class.forName(className); } catch (final Exception e) { throw new IllegalArgumentException("Class name was not recognised: " + className, e); } final ObjectMapper mapper = new ObjectMapper(); final JavaType type = mapper.getTypeFactory().constructType(clazz); final BeanDescription introspection = mapper.getSerializationConfig().introspect(type); final List<BeanPropertyDefinition> properties = introspection.findProperties(); final Set<String> fields = new HashSet<>(); for (final BeanPropertyDefinition property : properties) { fields.add(property.getName()); } return fields; } @Override public Set<Class> getTransformFunctions() { return TRANSFORM_FUNCTIONS; } @Override public Set<StoreTrait> getStoreTraits() { return graphFactory.getGraph().getStoreTraits(); } @Override public Set<Class> getGenerators() { return GENERATORS; } @Override public Set<Class> getOperations() { return (Set) graphFactory.getGraph().getSupportedOperations(); } @Override public Boolean isOperationSupported(final Class operation) { return graphFactory.getGraph().isSupported(operation); } private static Set<Class> getSubClasses(final Class<?> clazz) { final Set<URL> urls = new HashSet<>(); for (final String packagePrefix : System .getProperty(SystemProperty.PACKAGE_PREFIXES, SystemProperty.PACKAGE_PREFIXES_DEFAULT).split(",")) { urls.addAll(ClasspathHelper.forPackage(packagePrefix)); } Set<Class> classes = new HashSet<>(); classes.addAll(new Reflections(urls).getSubTypesOf(clazz)); keepPublicConcreteClasses(classes); return classes; } private static void keepPublicConcreteClasses(final Collection<Class> classes) { if (null != classes) { final Iterator<Class> itr = classes.iterator(); while (itr.hasNext()) { final Class clazz = itr.next(); if (null != clazz) { final int modifiers = clazz.getModifiers(); if (Modifier.isAbstract(modifiers) || Modifier.isInterface(modifiers) || Modifier.isPrivate(modifiers) || Modifier.isProtected(modifiers)) { itr.remove(); } } } } } }