aboutsummaryrefslogtreecommitdiffstats
path: root/src/net/java/sip/communicator/impl/gui/main/login/DefaultSecurityAuthority.java
blob: 03fe01e0be5c4080eb86a419b04c0a159707c141 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
/*
 * SIP Communicator, the OpenSource Java VoIP and Instant Messaging client.
 *
 * Distributable under LGPL license.
 * See terms of license at gnu.org.
 */
package net.java.sip.communicator.impl.gui.main.login;

import net.java.sip.communicator.impl.gui.*;
import net.java.sip.communicator.service.gui.*;
import net.java.sip.communicator.service.protocol.*;

/**
 * Utility class that can be used in cases where components other than the main
 * user interface may need to launch provider registration. At the time I am
 * writing this, the <tt>DefaultSecurityAuthority</tt> is being used by the
 * systray and
 *
 * @author Emil Ivov
 */
public class DefaultSecurityAuthority
    implements SecurityAuthority
{
    private boolean isUserNameEditable = false;

    /**
     * The provider that this authority would be responsible for.
     */
    private ProtocolProviderService provider = null;

    /**
     * Creates this authority for a particular provider.
     */
    public DefaultSecurityAuthority(ProtocolProviderService provider)
    {
        this.provider = provider;
    }

    /**
     * Used to login to the protocol providers
     *
     * @param realm the realm that the credentials are needed for
     * @param userCredentials the values to propose the user by default
     * @return The Credentials associated with the speciefied realm
     */
    public UserCredentials obtainCredentials(
            String realm,
            UserCredentials userCredentials)
    {
        return obtainCredentials(   realm,
                                    userCredentials,
                                    SecurityAuthority.AUTHENTICATION_REQUIRED);
    }


    /**
     * Used to login to the protocol providers
     *
     * @param realm the realm that the credentials are needed for
     * @param userCredentials the values to propose the user by default
     * @param reasonCode the reason for which we're asking for credentials
     * @return The Credentials associated with the speciefied realm
     */
    public UserCredentials obtainCredentials(
            String realm,
            UserCredentials userCredentials,
            int reasonCode)
    {
        ExportedWindow loginWindow
            = GuiActivator.getUIService()
                .getAuthenticationWindow(provider,
                                        realm,
                                        userCredentials,
                                        isUserNameEditable);

        loginWindow.setVisible(true);

        return userCredentials;
    }


    /**
     * Sets the userNameEditable property, which should indicate to the
     * implementations of this interface if the user name could be changed
     * by user or not.
     *
     * @param isUserNameEditable indicates if the user name could be changed
     * by user in the implementation of this interface.
     */
    public void setUserNameEditable(boolean isUserNameEditable)
    {
        this.isUserNameEditable = isUserNameEditable;
    }

    /**
     * Indicates if the user name is currently editable, i.e. could be
     * changed by user or not.
     *
     * @return <tt>true</tt> if the user name could be changed and
     * <tt>false</tt> otherwise.
     */
    public boolean isUserNameEditable()
    {
        return isUserNameEditable;
    }
}