org.apache.mina.core.service.DefaultTransportMetadata Maven / Gradle / Ivy

/*
 *  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.mina.core.service;

import java.net.SocketAddress;
import java.util.Collections;
import java.util.Set;

import org.apache.mina.core.session.IoSessionConfig;
import org.apache.mina.util.IdentityHashSet;

/**
 * A default immutable implementation of {@link TransportMetadata}.
 *
 * @author Apache MINA Project
 */
public class DefaultTransportMetadata implements TransportMetadata {

    private final String providerName;

    private final String name;

    private final boolean connectionless;

    /** The flag indicating that the transport support fragmentation or not */
    private final boolean fragmentation;

    private final Class addressType;

    private final Class sessionConfigType;

    private final Set> envelopeTypes;

    /**
     * Creates a new DefaultTransportMetadata instance
     * 
     * @param providerName The provider name
     * @param name The name
     * @param connectionless If the transport is UDP
     * @param fragmentation If fragmentation is supported
     * @param addressType The address type (IP V4 or IPV6)
     * @param sessionConfigType The session configuration type
     * @param envelopeTypes The types of supported messages
     */
    public DefaultTransportMetadata(String providerName, String name, boolean connectionless, boolean fragmentation,
            Class addressType, Class sessionConfigType,
            Class... envelopeTypes) {

        if (providerName == null) {
            throw new IllegalArgumentException("providerName");
        } else {
            this.providerName = providerName.trim().toLowerCase();

            if (this.providerName.length() == 0) {
                throw new IllegalArgumentException("providerName is empty.");
            }
        }
        
        if (name == null) {
            throw new IllegalArgumentException("name");
        } else {
            this.name = name.trim().toLowerCase();
            
            if (this.name.length() == 0) {
                throw new IllegalArgumentException("name is empty.");
            }
        }

        if (addressType == null) {
            throw new IllegalArgumentException("addressType");
        }

        if (envelopeTypes == null) {
            throw new IllegalArgumentException("envelopeTypes");
        }

        if (envelopeTypes.length == 0) {
            throw new IllegalArgumentException("envelopeTypes is empty.");
        }

        if (sessionConfigType == null) {
            throw new IllegalArgumentException("sessionConfigType");
        }

        this.connectionless = connectionless;
        this.fragmentation = fragmentation;
        this.addressType = addressType;
        this.sessionConfigType = sessionConfigType;

        Set> newEnvelopeTypes = new IdentityHashSet<>();
        for (Class c : envelopeTypes) {
            newEnvelopeTypes.add(c);
        }
        this.envelopeTypes = Collections.unmodifiableSet(newEnvelopeTypes);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public Class getAddressType() {
        return addressType;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public Set> getEnvelopeTypes() {
        return envelopeTypes;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public Class getSessionConfigType() {
        return sessionConfigType;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String getProviderName() {
        return providerName;
    }

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

    /**
     * {@inheritDoc}
     */
    @Override
    public boolean isConnectionless() {
        return connectionless;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public boolean hasFragmentation() {
        return fragmentation;
    }

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