1d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen/** 2d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * $Revision$ 3d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * $Date$ 4d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 5d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Copyright 2003-2007 Jive Software. 6d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 7d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * All rights reserved. Licensed under the Apache License, Version 2.0 (the "License"); 8d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * you may not use this file except in compliance with the License. 9d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * You may obtain a copy of the License at 10d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 11d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * http://www.apache.org/licenses/LICENSE-2.0 12d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 13d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Unless required by applicable law or agreed to in writing, software 14d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * distributed under the License is distributed on an "AS IS" BASIS, 15d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 16d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * See the License for the specific language governing permissions and 17d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * limitations under the License. 18d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 19d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 20d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chenpackage org.jivesoftware.smackx.workgroup; 21d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 22d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chenimport java.util.List; 23d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chenimport java.util.Map; 24d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 25d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen/** 26d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * An immutable class wrapping up the basic information which comprises a group chat invitation. 27d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 28d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @author loki der quaeler 29d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 30d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chenpublic class WorkgroupInvitation { 31d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 32d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen protected String uniqueID; 33d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 34d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen protected String sessionID; 35d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 36d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen protected String groupChatName; 37d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen protected String issuingWorkgroupName; 38d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen protected String messageBody; 39d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen protected String invitationSender; 40d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen protected Map<String, List<String>> metaData; 41d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 42d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen /** 43d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * This calls the 5-argument constructor with a null MetaData argument value 44d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 45d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @param jid the jid string with which the issuing AgentSession or Workgroup instance 46d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * was created 47d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @param group the jid of the room to which the person is invited 48d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @param workgroup the jid of the workgroup issuing the invitation 49d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @param sessID the session id associated with the pending chat 50d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @param msgBody the body of the message which contained the invitation 51d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @param from the user jid who issued the invitation, if known, null otherwise 52d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 53d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public WorkgroupInvitation (String jid, String group, String workgroup, 54d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen String sessID, String msgBody, String from) { 55d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen this(jid, group, workgroup, sessID, msgBody, from, null); 56d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 57d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 58d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen /** 59d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @param jid the jid string with which the issuing AgentSession or Workgroup instance 60d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * was created 61d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @param group the jid of the room to which the person is invited 62d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @param workgroup the jid of the workgroup issuing the invitation 63d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @param sessID the session id associated with the pending chat 64d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @param msgBody the body of the message which contained the invitation 65d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @param from the user jid who issued the invitation, if known, null otherwise 66d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @param metaData the metadata sent with the invitation 67d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 68d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public WorkgroupInvitation (String jid, String group, String workgroup, String sessID, String msgBody, 69d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen String from, Map<String, List<String>> metaData) { 70d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen super(); 71d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 72d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen this.uniqueID = jid; 73d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen this.sessionID = sessID; 74d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen this.groupChatName = group; 75d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen this.issuingWorkgroupName = workgroup; 76d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen this.messageBody = msgBody; 77d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen this.invitationSender = from; 78d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen this.metaData = metaData; 79d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 80d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 81d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen /** 82d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @return the jid string with which the issuing AgentSession or Workgroup instance 83d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * was created. 84d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 85d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public String getUniqueID () { 86d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen return this.uniqueID; 87d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 88d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 89d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen /** 90d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @return the session id associated with the pending chat; working backwards temporally, 91d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * this session id should match the session id to the corresponding offer request 92d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * which resulted in this invitation. 93d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 94d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public String getSessionID () { 95d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen return this.sessionID; 96d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 97d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 98d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen /** 99d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @return the jid of the room to which the person is invited. 100d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 101d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public String getGroupChatName () { 102d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen return this.groupChatName; 103d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 104d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 105d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen /** 106d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @return the name of the workgroup from which the invitation was issued. 107d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 108d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public String getWorkgroupName () { 109d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen return this.issuingWorkgroupName; 110d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 111d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 112d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen /** 113d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @return the contents of the body-block of the message that housed this invitation. 114d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 115d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public String getMessageBody () { 116d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen return this.messageBody; 117d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 118d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 119d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen /** 120d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @return the user who issued the invitation, or null if it wasn't known. 121d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 122d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public String getInvitationSender () { 123d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen return this.invitationSender; 124d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 125d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 126d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen /** 127d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @return the meta data associated with the invitation, or null if this instance was 128d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * constructed with none 129d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 130d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public Map<String, List<String>> getMetaData () { 131d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen return this.metaData; 132d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 133d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 134d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen} 135