001/* 002 * Licensed to the Apache Software Foundation (ASF) under one 003 * or more contributor license agreements. See the NOTICE file 004 * distributed with this work for additional information 005 * regarding copyright ownership. The ASF licenses this file 006 * to you under the Apache License, Version 2.0 (the 007 * "License"); you may not use this file except in compliance 008 * with the License. You may obtain a copy of the License at 009 * 010 * http://www.apache.org/licenses/LICENSE-2.0 011 * 012 * Unless required by applicable law or agreed to in writing, 013 * software distributed under the License is distributed on an 014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 015 * KIND, either express or implied. See the License for the 016 * specific language governing permissions and limitations 017 * under the License. 018 * 019 */ 020package org.apache.mina.core.service; 021 022import java.net.SocketAddress; 023import java.util.Set; 024 025import org.apache.mina.core.session.IoSession; 026import org.apache.mina.core.session.IoSessionConfig; 027 028/** 029 * Provides meta-information that describes an {@link IoService}. 030 * 031 * @author <a href="http://mina.apache.org">Apache MINA Project</a> 032 */ 033public interface TransportMetadata { 034 035 /** 036 * @return the name of the service provider (e.g. "nio", "apr" and "rxtx"). 037 */ 038 String getProviderName(); 039 040 /** 041 * @return the name of the service. 042 */ 043 String getName(); 044 045 /** 046 * @return <tt>true</tt> if the session of this transport type is 047 * <a href="http://en.wikipedia.org/wiki/Connectionless">connectionless</a>. 048 */ 049 boolean isConnectionless(); 050 051 /** 052 * @return {@code true} if the messages exchanged by the service can be 053 * <a href="http://en.wikipedia.org/wiki/IPv4#Fragmentation_and_reassembly">fragmented 054 * or reassembled</a> by its underlying transport. 055 */ 056 boolean hasFragmentation(); 057 058 /** 059 * @return the address type of the service. 060 */ 061 Class<? extends SocketAddress> getAddressType(); 062 063 /** 064 * @return the set of the allowed message type when you write to an 065 * {@link IoSession} that is managed by the service. 066 */ 067 Set<Class<? extends Object>> getEnvelopeTypes(); 068 069 /** 070 * @return the type of the {@link IoSessionConfig} of the service 071 */ 072 Class<? extends IoSessionConfig> getSessionConfigType(); 073}