001: /***************************************************************
002: * This file is part of the [fleXive](R) project.
003: *
004: * Copyright (c) 1999-2008
005: * UCS - unique computing solutions gmbh (http://www.ucs.at)
006: * All rights reserved
007: *
008: * The [fleXive](R) project is free software; you can redistribute
009: * it and/or modify it under the terms of the GNU General Public
010: * License as published by the Free Software Foundation;
011: * either version 2 of the License, or (at your option) any
012: * later version.
013: *
014: * The GNU General Public License can be found at
015: * http://www.gnu.org/copyleft/gpl.html.
016: * A copy is found in the textfile GPL.txt and important notices to the
017: * license from the author are found in LICENSE.txt distributed with
018: * these libraries.
019: *
020: * This library is distributed in the hope that it will be useful,
021: * but WITHOUT ANY WARRANTY; without even the implied warranty of
022: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
023: * GNU General Public License for more details.
024: *
025: * For further information about UCS - unique computing solutions gmbh,
026: * please see the company website: http://www.ucs.at
027: *
028: * For further information about [fleXive](R), please see the
029: * project website: http://www.flexive.org
030: *
031: *
032: * This copyright notice MUST APPEAR in all copies of the file!
033: ***************************************************************/package com.flexive.tests.embedded;
034:
035: import com.flexive.shared.CacheAdmin;
036: import com.flexive.shared.EJBLookup;
037: import com.flexive.shared.FxContext;
038: import com.flexive.shared.exceptions.FxAccountInUseException;
039: import com.flexive.shared.exceptions.FxApplicationException;
040: import com.flexive.shared.exceptions.FxLoginFailedException;
041: import com.flexive.shared.exceptions.FxLogoutFailedException;
042: import com.flexive.shared.interfaces.ACLEngine;
043: import com.flexive.shared.security.ACL;
044: import com.flexive.shared.security.UserTicket;
045: import com.flexive.shared.value.FxString;
046:
047: /**
048: * Helper base class to provide user login/logout and UserTicket information for tests
049: *
050: * @author Markus Plesser (markus.plesser@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at)
051: */
052: public class FxTestUtils {
053: /**
054: * Login the given user/password.
055: *
056: * @param username the user name
057: * @param password the password
058: * @throws FxLoginFailedException if the login failed
059: * @throws FxAccountInUseException if the user is already logged in (and not multilogin-capable)
060: */
061: public static void login(String username, String password)
062: throws FxLoginFailedException, FxAccountInUseException {
063: FxContext.get().login(username, password, true);
064: }
065:
066: /**
067: * Login a TestUser
068: *
069: * @param user TestUser
070: * @throws FxLoginFailedException if the login failed
071: * @throws FxAccountInUseException if the user is already logged in (and not multilogin-capable)
072: */
073: public static void login(TestUser user)
074: throws FxLoginFailedException, FxAccountInUseException {
075: FxContext.get().login(user.getUserName(), user.getPassword(),
076: true);
077: }
078:
079: /**
080: * The ticket of the user.
081: * <p/>
082: *
083: * @return The ticket of the user
084: */
085: public static UserTicket getUserTicket() {
086: return FxContext.get().getTicket();
087: }
088:
089: /**
090: * Change the current user for the test
091: *
092: * @param userName the test user name
093: * @param password the test user password
094: * @throws FxLoginFailedException
095: * @throws FxAccountInUseException
096: * @throws com.flexive.shared.exceptions.FxLogoutFailedException
097: *
098: */
099: public static void changeUser(String userName, String password)
100: throws FxLoginFailedException, FxAccountInUseException,
101: FxLogoutFailedException {
102: FxContext.get().logout();
103: FxContext.get().login(userName, password, true);
104: }
105:
106: /**
107: * Perform logout of the current user.
108: *
109: * @throws FxLogoutFailedException if the logout failed
110: */
111: public static void logout() throws FxLogoutFailedException {
112: FxContext.get().logout();
113: }
114:
115: /**
116: * Create a set of ACL's
117: *
118: * @param name array with the names of the ACL's
119: * @param category CATEGORY's
120: * @param mandator the mandator
121: * @return created ACL's
122: * @throws FxApplicationException
123: */
124: public static ACL[] createACLs(String[] name,
125: ACL.Category[] category, long mandator)
126: throws FxApplicationException {
127: assert name != null && category != null
128: && name.length == category.length : "Invalid parameter(s) for createACL!";
129: ACL[] acls = new ACL[name.length];
130: ACLEngine acl = EJBLookup.getACLEngine();
131: FxString label = new FxString("Unit Test ACL Label");
132: for (int i = 0; i < name.length; i++) {
133: long tmpId = acl.create(name[i], label, mandator,
134: "#AABBCC", "UnitTest ACL", category[i]);
135: acls[i] = CacheAdmin.getEnvironment().getACL(tmpId);
136: }
137: return acls;
138: }
139:
140: /**
141: * Create a new ACL.
142: *
143: * @param name
144: * @param category
145: * @param mandator
146: * @return
147: * @throws FxApplicationException
148: */
149: public static ACL createACL(String name, ACL.Category category,
150: long mandator) throws FxApplicationException {
151: return createACLs(new String[] { name },
152: new ACL.Category[] { category }, mandator)[0];
153: }
154:
155: /**
156: * Remove a set of ACL's
157: *
158: * @param acls the ACL's to remove
159: * @throws FxApplicationException
160: */
161: public static void removeACL(ACL... acls)
162: throws FxApplicationException {
163: ACLEngine aclEngine = EJBLookup.getACLEngine();
164: for (ACL acl : acls)
165: aclEngine.remove(acl.getId());
166: }
167: }
|