diff options
Diffstat (limited to 'protocols/bundles/org.jivesoftware.smack/src/org/jivesoftware/smack/UserAuthentication.java')
-rw-r--r-- | protocols/bundles/org.jivesoftware.smack/src/org/jivesoftware/smack/UserAuthentication.java | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/protocols/bundles/org.jivesoftware.smack/src/org/jivesoftware/smack/UserAuthentication.java b/protocols/bundles/org.jivesoftware.smack/src/org/jivesoftware/smack/UserAuthentication.java new file mode 100644 index 000000000..2d3a319ac --- /dev/null +++ b/protocols/bundles/org.jivesoftware.smack/src/org/jivesoftware/smack/UserAuthentication.java @@ -0,0 +1,55 @@ +/** + * $RCSfile$ + * $Revision$ + * $Date$ + * + * Copyright 2003-2004 Jive Software. + * + * All rights reserved. Licensed 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.jivesoftware.smack; + +/** + * There are two ways to authenticate a user with a server. Using SASL or Non-SASL + * authentication. This interface makes {@link SASLAuthentication} and + * {@link NonSASLAuthentication} polyphormic. + * + * @author Gaston Dombiak + */ +interface UserAuthentication { + + /** + * Authenticates the user with the server. This method will return the full JID provided by + * the server. The server may assign a full JID with a username and resource different than + * the requested by this method. + * + * @param username the username that is authenticating with the server. + * @param password the password to send to the server. + * @param resource the desired resource. + * @return the full JID provided by the server while binding a resource for the connection. + * @throws XMPPException if an error occures while authenticating. + */ + String authenticate(String username, String password, String resource) throws + XMPPException; + + /** + * Performs an anonymous authentication with the server. The server will created a new full JID + * for this connection. An exception will be thrown if the server does not support anonymous + * authentication. + * + * @return the full JID provided by the server while binding a resource for the connection. + * @throws XMPPException if an error occures while authenticating. + */ + String authenticateAnonymously() throws XMPPException; +} |