com.fasterxml.clustermate.service.ServiceRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of clustermate-service Show documentation
Building blocks for ClusterMate-based services and servers.
The newest version!
package com.fasterxml.clustermate.service;

import java.io.*;
import java.util.HashMap;
import java.util.Map;

import com.fasterxml.storemate.shared.ByteRange;
import com.fasterxml.storemate.shared.util.UTF8UrlEncoder;

import com.fasterxml.clustermate.api.ClusterMateConstants;
import com.fasterxml.clustermate.api.DecodableRequestPath;
import com.fasterxml.clustermate.api.OperationType;
import com.fasterxml.clustermate.service.util.StatsCollectingInputStream;

/**
 * Interface class that defines abstraction implemented by classes that
 * enclose details of a (HTTP) request that server receives.
 *
 * Separated out to allow handlers to operate independent of the
 * container like Servlet or JAX-RS container.
 */
public abstract class ServiceRequest
    implements DecodableRequestPath
{
    protected final static UTF8UrlEncoder _urlEncoder = new UTF8UrlEncoder(false);

    protected final static Map _operationTypes = new HashMap();
    static {
        // let's allow upper and lower case variants, but no mixed
        for (OperationType type : OperationType.values()) {
            String name = type.name();
            _operationTypes.put(name, type);
            _operationTypes.put(name.toLowerCase().intern(), type);
        }
    }
    
    /**
     * Type of operation, if known (if not, usually use CUSTOM)
     */
    protected final OperationType _operation;
    
    /**
     * This is the full non-decoded original path of the request.
     */
    protected final String _originalFullPath;

    /**
     * Path override assigned by {@link #setPath}, if any.
     */
    protected String _currentPath;

    /**
     * Whether path we have has been URL decoded or not.
     */
    protected final boolean _isPathDecoded;

    protected StatsCollectingInputStream _input;
    
    /*
    /**********************************************************************
    /* Construction
    /**********************************************************************
     */

    protected ServiceRequest(String origPath, boolean isPathDecoded,
            OperationType operation)
    {
        _originalFullPath = origPath;
        _currentPath = origPath;
        _isPathDecoded = isPathDecoded;
        _operation = operation;
    }
    
    /*
    /**********************************************************************
    /* Access to information other than path
    /**********************************************************************
     */

    public final InputStream getInputStream() throws IOException {
        if (_input == null) {
            _input = new StatsCollectingInputStream(getNativeInputStream());
        }
        return _input;
    }

    public abstract InputStream getNativeInputStream() throws IOException;
    
    public ByteRange findByteRange()
    {
        String rangeStr = getHeader(ClusterMateConstants.HTTP_HEADER_RANGE_FOR_REQUEST);
        return (rangeStr == null) ? null : ByteRange.valueOf(rangeStr);
    }

    /*
    /**********************************************************************
    /* Statistics
    /**********************************************************************
     */

    public final long getBytesRead() {
        return (_input == null) ? 0L : _input.getBytesRead();
    }
    
    /*
    /**********************************************************************
    /* Path handling (mostly from DecodableRequestPath)
    /**********************************************************************
     */

    @Override
    public OperationType getOperation() {
        return _operation;
    }
    
    @Override
    public abstract String getQueryParameter(String key);

    @Override
    public abstract String getHeader(String key);
    
    @Override
    public String getPath() {
        return _currentPath;
    }

    @Override
    public String getDecodedPath() {
        if (_isPathDecoded) {
            return _currentPath;
        }
        if (_currentPath == null) {
            return null;
        }
        return _decodePath(_currentPath);
    }

    @Override
    public boolean isPathDecoded() { return _isPathDecoded; }
    
    
    @Override
    public void setPath(String path) {
        _currentPath = path;
    }
    
    @Override
    public String nextPathSegment() {
        String str = _currentPath;
        if (str == null) {
            return null;
        }
        int ix = str.indexOf('/');
        if (ix < 0) { // last segment...
            _currentPath = null;
            return str;
        }
        _currentPath = str.substring(ix+1);
        str = str.substring(0, ix);
        return str;
    }

    @Override
    public boolean matchPathSegment(String segment) {
        String str = _currentPath;
        final int len = segment.length();
        if (str == null || !str.startsWith(segment)) {
            return false;
        }
        // ok; we now it starts with it, but is it followed by a slash?
        if (str.length() == len) { // full match
            _currentPath = null;
            return true;
        }
        if (str.charAt(len) == '/') { // yeppers
            _currentPath = _currentPath.substring(len+1);
            return true;
        }
        return false;
    }

    /*
    /**********************************************************************
    /* Helper methods
    /**********************************************************************
     */

    protected String _decodePath(String encodedPath)
    {
        return _urlEncoder.decode(encodedPath);
    }

    protected static OperationType _resolveOperation(String desc, OperationType defType)
    {
        OperationType type = _operationTypes.get(desc);
        return (type == null) ? defType : type;
    }
}