com.github.restup.registry.BasicResource Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of up-core Show documentation
There is a newer version: 0.0.5
package com.github.restup.registry;

import java.io.Serializable;
import java.lang.reflect.Type;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import com.github.restup.mapping.MappedClass;
import com.github.restup.mapping.fields.MappedField;
import com.github.restup.path.ResourcePath;
import com.github.restup.path.ResourcePathsProvider;
import com.github.restup.query.Pagination;
import com.github.restup.registry.settings.ControllerMethodAccess;
import com.github.restup.registry.settings.ServiceMethodAccess;
import com.github.restup.repository.ResourceRepositoryOperations;
import com.github.restup.service.ResourceService;
import com.github.restup.service.ResourceServiceOperations;
import com.github.restup.util.Assert;

/**
 * Resource meta data, defining resource name, type, service implementation, etc.
 */
class BasicResource implements Resource {

    private final Type type;
    private final String name;
    private final String pluralName;
    private final String basePath;

    private final ResourceRegistry registry;
    private final MappedClass mapping;
    private final MappedField identityField;

    private final ControllerMethodAccess controllerMethodAccess;
    private final ServiceMethodAccess serviceMethodAccess;
    private final Pagination defaultPagination;
    private final ResourcePathsProvider defaultSparseFieldsProvider;
    private final ResourcePathsProvider restrictedFieldsProvider;
    private ResourceServiceOperations serviceOperations;
    private ResourceRepositoryOperations repositoryOperations;
    private ResourceService service;

    BasicResource(Type type, String name, String pluralName, String basePath, ResourceRegistry registry, MappedClass mapping, MappedField identityField, ControllerMethodAccess controllerAccess, ServiceMethodAccess serviceAccess, Pagination pagination, ResourcePathsProvider defaultSparseFields, ResourcePathsProvider restrictedFields) {
        Assert.notNull(type, "type is required");
        Assert.notNull(name, "name is required");
        Assert.notNull(pluralName, "pluralName is required");
        Assert.notNull(basePath, "basePath is required");
        Assert.notNull(registry, "registry is required");
        Assert.notNull(mapping, "mapping is required");
        Assert.notNull(controllerAccess, "controllerAccess is required");
        Assert.notNull(serviceAccess, "serviceAccess is required");
        Assert.notNull(pagination, "pagination is required");
        Assert.notNull(defaultSparseFields, "defaultSparseFields is required");
        Assert.notNull(restrictedFields, "restrictedFields is required");
        this.type = type;
        this.name = name;
        this.basePath = basePath;
        this.pluralName = pluralName;
        this.registry = registry;
        this.mapping = mapping;
        this.identityField = identityField;
        this.controllerMethodAccess = controllerAccess;
        this.serviceMethodAccess = serviceAccess;
        this.defaultPagination = pagination;
        this.defaultSparseFieldsProvider = defaultSparseFields;
        this.restrictedFieldsProvider = restrictedFields;
    }


    @Override
    public List getAllPaths() {
        //TODO better to cache immutable paths?
        List paths = new ArrayList();
        appendPaths(paths, mapping, null);
        return paths;
    }

    private void appendPaths(List target, MappedClass mapping, ResourcePath parent) {
        //TODO better to cache immutable paths?
        for (MappedField mf : mapping.getAttributes()) {
            ResourcePath path = parent == null ? ResourcePath.path(this, mf) : ResourcePath.path(parent, mf);
            target.add(path);
            MappedClass subPath = registry.getMappedClass(mf.getType());
            if (subPath != null) {
                appendPaths(target, subPath, path);
            }
        }
    }

    @Override
    public Collection> getRelationships() {
        return registry.getRelationships(name);
    }

	@Override
    public List> getRelationshipsTo() {
        List> result = new ArrayList<>();
        Collection> relationships = getRelationships();
        if (relationships != null) {
            for (ResourceRelationship relationship : relationships) {
                if (relationship.isTo(this)) {
                    result.add(relationship);
                }
            }
        }
        return result;
    }

    @Override
    public Type getType() {
        return type;
    }

    @Override
    public String getName() {
        return name;
    }

    @Override
    public String getPluralName() {
        return pluralName;
    }

    @Override
    public MappedClass getMapping() {
        return mapping;
    }

    @Override
    public MappedField getIdentityField() {
        return identityField;
    }

    @Override
    public ResourceService getService() {
        return service;
    }

    protected final void setService(ResourceService service) {
        Assert.isNull(this.service, "service is immutable");
        this.service = service;
    }

    @Override
    public ResourceServiceOperations getServiceOperations() {
        return serviceOperations;
    }

    protected final void setServiceOperations(ResourceServiceOperations serviceOperations) {
        Assert.isNull(this.serviceOperations, "serviceOperations is immutable");
        this.serviceOperations = serviceOperations;
    }

    @Override
    public ResourceRepositoryOperations getRepositoryOperations() {
        return repositoryOperations;
    }

    protected final void setRepositoryOperations(ResourceRepositoryOperations repositoryOperations) {
        Assert.isNull(this.repositoryOperations, "repositoryOperations is immutable");
        this.repositoryOperations = repositoryOperations;
    }

    @Override
    public ControllerMethodAccess getControllerMethodAccess() {
        return controllerMethodAccess;
    }

    @Override
    public ServiceMethodAccess getServiceMethodAccess() {
        return serviceMethodAccess;
    }

    @Override
    public ResourceRegistry getRegistry() {
        return registry;
    }

    @Override
    public Pagination getDefaultPagination() {
        return defaultPagination;
    }

    /**
     * @return the fields returned by default for sparse fields requests.
     */
    @Override
    public List getDefaultSparseFields() {
        return defaultSparseFieldsProvider.getPaths(this);
    }

    public ResourcePathsProvider getDefaultSparseFieldsProvider() {
        return defaultSparseFieldsProvider;
    }

    /**
     * Returns any fields to which the requestor is not permitted to read
     */
    @Override
    public List getRestrictedFields() {
        return restrictedFieldsProvider.getPaths(this);
    }

    public ResourcePathsProvider getRestrictedFieldsProvider() {
        return restrictedFieldsProvider;
    }

    @Override
    public String getBasePath() {
        return basePath;
    }

    @Override
    public String toString() {
        return name;
    }

}