org.apache.jetspeed.capabilities.impl.ClientImpl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jetspeed-capability Show documentation
Capability Components defines an api for "guessing" what client is accessing a web application by looking for clues in the request headers then return a list of that client's capabilites i.e. HTML 4.0, WML, Javascript 1.2, etc.
There is a newer version: 2.3.1
Show newest version
/*
 * 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.jetspeed.capabilities.impl;

import org.apache.commons.collections.CollectionUtils;
import org.apache.jetspeed.capabilities.Capability;
import org.apache.jetspeed.capabilities.Client;
import org.apache.jetspeed.capabilities.MimeType;

import java.util.ArrayList;
import java.util.Collection;

/**
 * Simple implementation of the ClientRegistry interface.
 *
 * @author Stephan Hesmer
 * @author Rapha\u00ebl Luta
 * @author Roger Ruttimann
 * @version $Id: ClientImpl.java 1536817 2013-10-29 17:11:29Z taylor $
 */
public class ClientImpl implements Client, java.io.Serializable {
    private String userAgentPattern = "";
    private String manufacturer = "";
    private String model = "";
    private String version = "";
    private String name;
    private Collection mimetypes;
    private Collection capabilities;
    private int preferredMimeTypeId;

    private int clientId;
    private int evalOrder = 0;

    public ClientImpl() {
    }

    /**
     * Implements the equals operation so that 2 elements are equal if all their member values are equal.
     */
    public boolean equals(Object object) {

        if (!(object instanceof Client)) {
            return false;
        }

        ClientImpl obj = (ClientImpl) object;

        if (name != null) {
            if (!name.equals(obj.name)) {
                return false;
            }
        } else {
            if (obj.name != null) {
                return false;
            }
        }

        if (userAgentPattern != null) {
            if (!userAgentPattern.equals(obj.userAgentPattern)) {
                return false;
            }
        } else {
            if (obj.userAgentPattern != null) {
                return false;
            }
        }

        if (manufacturer != null) {
            if (!manufacturer.equals(obj.manufacturer)) {
                return false;
            }
        } else {
            if (obj.manufacturer != null) {
                return false;
            }
        }

        if (model != null) {
            if (!model.equals(obj.model)) {
                return false;
            }
        } else {
            if (obj.model != null) {
                return false;
            }
        }

        if (version != null) {
            if (!version.equals(obj.version)) {
                return false;
            }
        } else {
            if (obj.version != null) {
                return false;
            }
        }
        if (mimetypes != null) {
            if (!CollectionUtils.isEqualCollection(mimetypes, obj.mimetypes)) {
                return false;
            }
        } else {
            if (obj.mimetypes != null) {
                return false;
            }
        }

        if (capabilities != null) {
            if (!(CollectionUtils.isEqualCollection(capabilities, obj.capabilities))) {
                return false;
            }
        } else {
            if (obj.capabilities != null) {
                return false;
            }
        }
        return true;
    }

    public String getUserAgentPattern() {
        return userAgentPattern;
    }

    public void setUserAgentPattern(String userAgentPattern) {
        this.userAgentPattern = userAgentPattern;
    }

    public String getManufacturer() {
        return manufacturer;
    }

    public void setManufacturer(String name) {
        manufacturer = name;
    }

    public String getModel() {
        return model;
    }

    public void setModel(String name) {
        model = name;
    }

    public String getVersion() {
        return version;
    }

    public void setVersion(String name) {
        version = name;
    }

    public Collection getMimetypes() {
        if (this.mimetypes == null) {
            this.mimetypes = new ArrayList();
        }
        return mimetypes;
    }

    public void setMimetypes(Collection mimetypes) {
        this.mimetypes = mimetypes;
    }

    public Collection getCapabilities() {
        if (capabilities == null) {
            capabilities = new ArrayList();
        }
        return capabilities;
    }

    public void setCapabilities(Collection capabilities) {
        this.capabilities = capabilities;
    }

    /**
     * Set Client ID -- Assigns the Client ID
     *
     * @param id
     */
    public void setClientId(int id) {
        this.clientId = id;
    }

    /**
     * Get Client ID
     *
     * @return Client ID
     */
    public int getClientId() {
        return this.clientId;
    }

    /**
     * @return
     */
    public String getName() {
        return name;
    }

    /**
     * @param string
     */
    public void setName(String string) {
        name = string;
    }

    /**
     * @return Preferred MimeType ID for Client
     */
    public int getPreferredMimeTypeId() {
        return this.preferredMimeTypeId;
    }

    /**
     * Set preferred Mimetype ID for Client
     *
     * @param mimeTypeId MimeTypeId
     */
    public void setPreferredMimeTypeId(int mimeTypeId) {
        this.preferredMimeTypeId = mimeTypeId;
    }

    /**
     * @return Returns the evalOrder.
     */
    public int getEvalOrder() {
        return evalOrder;
    }

    /**
     * @param evalOrder The evalOrder to set.
     */
    public void setEvalOrder(int evalOrder) {
        this.evalOrder = evalOrder;
    }
}