com.github.theholywaffle.teamspeak3.api.wrapper.ServerQueryInfo Maven / Gradle / Ivy
package com.github.theholywaffle.teamspeak3.api.wrapper;
/*
* #%L
* TeamSpeak 3 Java API
* %%
* Copyright (C) 2014 Bert De Geyter
* %%
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
* #L%
*/
import com.github.theholywaffle.teamspeak3.TS3Api;
import com.github.theholywaffle.teamspeak3.TS3ApiAsync;
import com.github.theholywaffle.teamspeak3.api.ClientProperty;
import com.github.theholywaffle.teamspeak3.api.VirtualServerProperty;
import com.github.theholywaffle.teamspeak3.api.VirtualServerStatus;
import java.util.Map;
/**
* A class containing information about a server query, returned by the
* API methods {@link TS3Api#whoAmI()} and {@link TS3ApiAsync#whoAmI()}.
*/
public class ServerQueryInfo extends Wrapper {
/**
* Creates a new {@code ServerQueryInfo} from the information present in the provided map.
*
* @param map
* the map containing the key-value pairs abstracted by this object
*/
public ServerQueryInfo(Map map) {
super(map);
}
/**
* Gets the ID of the channel the server query is currently in.
*
* @return the ID of the current channel
*/
public int getChannelId() {
return getInt("client_channel_id");
}
/**
* Gets the ID of the server query in the database.
*
* In case this server query account was created by a client,
* its database ID will be identical to the client's database ID.
*
*
* @return the server query's database ID
*/
public int getDatabaseId() {
return getInt(ClientProperty.CLIENT_DATABASE_ID);
}
/**
* Gets the client ID of the server query.
*
* @return the server query's client ID
*/
public int getId() {
return getInt("client_id");
}
/**
* Gets the username that was used when logging the query in (using a username-password combination).
*
* This username was set when creating the server query login and doesn't have to be related to
* the client who created the server query login.
*
* In case a server query is not logged in yet, this method will return an empty string.
*
*
* @return the username used when logging this query in
*
* @see TS3Api#login(String, String) TS3Api#login(username, password) - logging in server queries
*/
public String getLoginName() {
return get(ClientProperty.CLIENT_LOGIN_NAME);
}
/**
* Gets the nickname currently used by the server query.
* Unless explicitly set, the nickname will be formatted like
* username from ip:port
*
* Nicknames are only assigned after a virtual server has been selected.
* Until then, this method will return an empty string.
*
*
* @return the current nickname of the server query
*/
public String getNickname() {
return get(ClientProperty.CLIENT_NICKNAME);
}
/**
* Gets the ID of the virtual server on which the server query login was created.
*
* This method will return {@code 0} (the ID of the template server) if a server query is
* not logged in or using the {@code serveradmin} login.
*
*
* @return the ID of the virtual server this server query belongs to
*/
public int getOriginServerId() {
return getInt("client_origin_server_id");
}
/**
* Gets the unique identifier of the server query.
*
* In case this server query account was created by a client,
* its unique ID will be identical to the client's unique ID.
*
*
* @return the server query's unique ID
*/
public String getUniqueIdentifier() {
return get(ClientProperty.CLIENT_UNIQUE_IDENTIFIER);
}
/**
* Gets the ID of the currently selected virtual server.
*
* If used on a non-commercial TeamSpeak instance which can only host 1 virtual server,
* this ID will always be 1.
*
* If no virtual server has been selected yet, this method will return {@code 0}.
*
*
* @return the ID of the current virtual server or {@code 0} if none is selected
*/
public int getVirtualServerId() {
return getInt(VirtualServerProperty.VIRTUALSERVER_ID);
}
/**
* Gets the port used by the currently selected virtual server.
*
* If no virtual server has been selected yet, this method will return {@code 0}.
*
*
* @return the port used by the current virtual server or {@code 0} if none is selected
*/
public int getVirtualServerPort() {
return getInt(VirtualServerProperty.VIRTUALSERVER_PORT);
}
/**
* Gets the status of the currently selected virtual server.
*
* If no virtual server has been selected yet, this method will return {@link VirtualServerStatus#UNKNOWN}.
*
*
* @return the status of the current virtual server
*/
public VirtualServerStatus getVirtualServerStatus() {
final String status = get(VirtualServerProperty.VIRTUALSERVER_STATUS);
for (final VirtualServerStatus s : VirtualServerStatus.values()) {
if (s.getName().equals(status)) {
return s;
}
}
return VirtualServerStatus.UNKNOWN;
}
/**
* Gets the unique identifier of the currently selected virtual server.
*
* If no virtual server has been selected yet, this method will return an empty string.
*
*
* @return the unique ID of the current virtual server
*/
public String getVirtualServerUniqueIdentifier() {
return get(VirtualServerProperty.VIRTUALSERVER_UNIQUE_IDENTIFIER);
}
}