Comment author: @pkriens

In this case, the interface was no necessary. The conditions were designed to use a factory approach, the implementation of ConditionalPermissionAdmin must always use the getCondition() method and the return value does not even have to extend the implementation class, the return value must implement the Condition interface only (It can even return the TRUE or FALSE instances).

Unfortunately, the test verified that the class relation, so this is also changed. the UserPromptCondition is now clean, there are no public methods outside the static getCondition method. All tests pass.

Eclipse Workspace Patch 1.0

P org.osgi.test.cases.policy

Index: src/org/osgi/test/cases/policy/tbc/UserPromptCondition/GetCondition.java

RCS file: /cvshome/build/org.osgi.test.cases.policy/src/org/osgi/test/cases/policy/tbc/UserPromptCondition/GetCondition.java,v retrieving revision 1.3 diff -u -r1.3 GetCondition.java --- src/org/osgi/test/cases/policy/tbc/UserPromptCondition/GetCondition.java 18 Nov 2005 20:20:18 -0000 1.3 +++ src/org/osgi/test/cases/policy/tbc/UserPromptCondition/GetCondition.java 7 Jul 2006 07:28:49 -0000 @ @ -99,7 +99,9 @ @ MessagesConstants.ASSERT_NOT_NULL, new String[] { "Created UserPrompt" }), condition);

tbc.assertTrue("Asserts that the returned Condition is an instanceof UserPromptCondition.",(condition instanceof UserPromptCondition));
// ### The following test is not valid. The condition does not
// have to be an instance of the UserPromptCondition
//tbc.assertTrue("Asserts that the returned Condition is an instanceof UserPromptCondition.",(condition instanceof UserPromptCondition)); } catch (Exception e) { tbc.fail(MessagesConstants.getMessage( MessagesConstants.UNEXPECTED_EXCEPTION, new String[] { @ @ -455,7 +457,10 @ @ MessagesConstants.ASSERT_NOT_NULL, new String[] { "Created UserPrompt" }), condition);
tbc.assertTrue("Asserts that the returned Condition is an instanceof UserPromptCondition.",(condition instanceof UserPromptCondition));
//### See 9.7.1, a Condition object must implement the
// Condition interface, it does not have to be an instance of
// the given implementation class.
//tbc.assertTrue("Asserts that the returned Condition is an instanceof UserPromptCondition.",(condition instanceof UserPromptCondition)); } catch (Exception e) { tbc.fail(MessagesConstants.getMessage( MessagesConstants.UNEXPECTED_EXCEPTION, new String[] {

P org.osgi.util.mobile

Index: src/org/osgi/util/mobile/UserPromptCondition.java

RCS file: /cvshome/build/org.osgi.util.mobile/src/org/osgi/util/mobile/UserPromptCondition.java,v retrieving revision 1.23 diff -u -r1.23 UserPromptCondition.java --- src/org/osgi/util/mobile/UserPromptCondition.java 21 Jun 2006 17:39:27 -0000 1.23 +++ src/org/osgi/util/mobile/UserPromptCondition.java 7 Jul 2006 07:28:50 -0000 @ @ -17,255 +17,124 @ @ */ package org.osgi.util.mobile;

-import java.util.Dictionary; -import org.osgi.framework.AdminPermission; +import java.lang.reflect.; +import java.security.; + import org.osgi.framework.Bundle; -import org.osgi.service.condpermadmin.Condition; -import org.osgi.service.condpermadmin.ConditionInfo; +import org.osgi.service.condpermadmin.*;

/**

Class representing a user prompt condition. Instances of this class hold two
values: a prompt string that is to be displayed to the user and the
permission level string according to MIDP2.0 (oneshot, session, blanket).
- - */ -public class UserPromptCondition implements Condition {
- +public class UserPromptCondition { /**
- - @ skip
- - The classNameProperty property can be used extend this API. This is not
- - part of the OSGi specification and can be changed at any release.
- - Implementers are assumed to rewrite this package or include it into their
- - implementation budle. Notice that the initialization will fail if the
- - bundle exporting the implementation is not loaded yet. */
- protected static interface UserPromptConditionFactory {
- /**
- - @ skip
- */
- public UserPromptCondition getInstance(
- Bundle bundle,
- String levels,
- String defaultLevel,
- String catalogName,
- String message);
- }
- private static UserPromptConditionFactory factory = null;
- /**
- - @ skip
- */
- protected static void setFactory(UserPromptConditionFactory factory) {
- SecurityManager sm = System.getSecurityManager();
- if (sm!=null) {
- sm.checkPermission(new AdminPermission("",""));
- }
- UserPromptCondition.factory = factory;
- }
- private final Bundle bundle;
- private final String levels;
- private final String defaultLevel;
- private final String catalogName;
- private final String message;
- private UserPromptCondition realUserPromptCondition;
- private static final String classNameProperty = "org.osgi.vendor.mobile.UserPromptCondition";
- private static Method getCondition;

/**
- @ skip
*/
protected static UserPromptCondition unWrap(UserPromptCondition c) {
if (c.realUserPromptCondition==null) return c;
return c.realUserPromptCondition;
static void init() {
getCondition = (Method) AccessController
.doPrivileged(new PrivilegedAction() {
public Object run() {
try {
String className = System
.getProperty(classNameProperty);
if (className == null)
throw new NoClassDefFoundError(
classNameProperty
- " property not set, UserPromptCondition not supported");
Class delegateClass;
delegateClass = Class.forName(className);
Method result = delegateClass.getMethod(
"getCondition",
new Class[] {Bundle.class,
ConditionInfo.class });
if (!Modifier.isStatic(result.getModifiers()))
throw new NoSuchMethodError(
"getCondition method must be static");
return result;
}
catch (Exception e) {
throw new RuntimeException(
"Cannot create UserPromptCondition " + e);
}
}
}); }

/**
- Returns a UserPromptCondition object with the given prompt string and permission
- level. The user should be given choice as to what level of permission is
- given. Thus, the lifetime of the permission is controlled by the user.
*
- Returns a UserPromptCondition object with the given prompt string and
- permission level. The user should be given choice as to what level of
- permission is given. Thus, the lifetime of the permission is controlled
- by the user.
- - @ param bundle the bundle to ask about.
- @ param conditionInfo the conditionInfo containing the construction information. Its
- {@ link ConditionInfo#getArgs()} method should return a String array with 4
- strings in it:
- the possible permission levels. This is a comma-separated list that can contain
- following strings: ONESHOT SESSION BLANKET. The order is not important. This
- parameter is case-insensitive.
- the default permission level, one chosen from the possible permission levels. If
- it is an empty string, then there is no default. This parameter
- is case-insensitive.
- the message catalog base name. It will be loaded by a {@ link java.util.ResourceBundle},
- or equivalent
- from an exporting OSGi Bundle. Thus, if the catalogName is "com.provider.messages.userprompt",
- then there should be an OSGi Bundle exporting the "com.provider.messages" package, and inside
- it files like "userprompt_en_US.properties".
- textual description of the condition, to be displayed to the user. If
- it starts with a '%' sign, then the message is looked up from the catalog specified previously.
- The key is the rest of the string after the '%' sign.
- @ return The requested UserPromptCondition.
- @ param conditionInfo the conditionInfo containing the construction
- information. Its {@ link ConditionInfo#getArgs()} method should
- return a String array with 4 strings in it:
- the possible permission levels. This is a comma-separated
- list that can contain following strings: ONESHOT SESSION BLANKET.
- The order is not important. This parameter is case-insensitive.
- the default permission level, one chosen from the possible
- permission levels. If it is an empty string, then there is no
- default. This parameter is case-insensitive.
- the message catalog base name. It will be loaded by a
- {@ link java.util.ResourceBundle}, or equivalent from an exporting
- OSGi Bundle. Thus, if the catalogName is
- "com.provider.messages.userprompt", then there should be an OSGi
- Bundle exporting the "com.provider.messages" package, and inside
- it files like "userprompt_en_US.properties".
- textual description of the condition, to be displayed to the
- user. If it starts with a '%' sign, then the message is looked up
- from the catalog specified previously. The key is the rest of the
- string after the '%' sign.
- @ return The requested UserPromptCondition (not required to be a subclass,
- see 9.7.1).
  - @ throws IllegalArgumentException if the parameters are malformed.
- @ throws NullPointerException if one of the parameters is null.
- @ throws NullPointerException if one of the parameters is
- null. */
public static Condition getCondition(Bundle bundle,ConditionInfo conditionInfo)
{
String[] args = conditionInfo.getArgs();
if (args==null) throw new NullPointerException("args");
if (args.length!=4) throw new IllegalArgumentException("args.length=="+args.length+" (should be 4)");
if (bundle==null) throw new NullPointerException("bundle");
String levels = args[0];
String defaultLevel = args[1];
String catalogName = args[2];
String message = args[3];
if (levels==null) throw new NullPointerException("levels");
if (defaultLevel==null) throw new NullPointerException("defaultLevel");
if (catalogName==null) throw new NullPointerException("catalogName");
if (message==null) throw new NullPointerException("message");
if (factory==null) {
// the bundle implementing the UserPromptCondition has not started yet.
// Do wrapping magick.
return new UserPromptCondition(false,bundle,levels,defaultLevel,catalogName,message);
} else {
// there is already a factory, no need to do any wrapping magic
return factory.getInstance(bundle,levels,defaultLevel,catalogName,message);
}
}
/**
- Instances of the UserPromptCondition are simply store the construction parameters
- until a "real" UserPromptCondition is registered in setFactory(). At that point, it
- will delegate all calls there.
- @ param unused this parameter is here so that ConditionalPermissionAdmin would not
- use this as the constructor instead of the getInstance
- @ param bundle
- @ param levels
- @ param defaultLevel
- @ param catalogName
- @ param message
*/
private UserPromptCondition(boolean unused,Bundle bundle,String levels,String defaultLevel,String catalogName,String message) {
this.bundle=bundle;
this.levels=levels;
this.defaultLevel=defaultLevel;
this.catalogName=catalogName;
this.message=message;
}
/**
- @ skip
*/
protected UserPromptCondition() {
bundle=null;
levels=null;
defaultLevel=null;
catalogName=null;
message=null;
}
public static Condition getCondition(Bundle bundle,
ConditionInfo conditionInfo) {
if (bundle == null || conditionInfo == null)
throw new NullPointerException("bundle " + bundle + " or info "
- conditionInfo + " must not be null");
try {
// not synchronized so could theor. happen multiple times
// but that is a bit wasteful but not harmful. At least
// we keep on trying if the loading order is messed up
// and we try to use before the implementation exists.
if ( getCondition == null )
init();
return (Condition) getCondition.invoke(null, new Object[] {bundle,
conditionInfo});
}
catch (IllegalAccessException e) {
throw new RuntimeException("Implementation constructor is not public ("
- classNameProperty + ")" + e);
}
catch (InvocationTargetException e) {
Throwable t = e.getTargetException();
if (t instanceof IllegalArgumentException)
throw (IllegalArgumentException) t;
/**
- Check if a factory is registered, and if yes, create userprompt to delegate calls to.
*/
private void lookForImplementation() {
if ((realUserPromptCondition==null)&&(factory!=null)) {
realUserPromptCondition = factory.getInstance(bundle,levels,defaultLevel,catalogName,message);
}
}
/**
- Checks if the {@ link #isSatisfied()} method needs to prompt the user, thus cannot
- give results instantly.
- This depends on the permission level given in
- {@ link UserPromptCondition#getCondition(Bundle, ConditionInfo)}.
- - ONESHOT - isPostponed always returns true. The user is prompted for question every time.
- - SESSION - isPostponed returns true until the user decides either yes or no for the current session.
- - BLANKET - isPostponed returns true until the user decides either always or never.
- Regardless of the session level, the user is always given the option to reject the prompt
- permanently, as if BLANKET/never was chosen. In this case, the question is not postponed
- anymore, and {@ link #isSatisfied()} returns false.
- If the system supports an separately accessible permission management GUI,
- that may reset the condition
- to its initial state.
- @ return True, if user interaction is needed.
*/
public boolean isPostponed() {
lookForImplementation();
if (realUserPromptCondition!=null) {
return realUserPromptCondition.isPostponed();
} else {
return true;
}
}
/**
- Checks whether the condition may change during the lifetime of the UserPromptCondition object.
- This depends on the permission level given in
- {@ link UserPromptCondition#getCondition(Bundle, ConditionInfo)}.
- - ONESHOT - true
- - SESSION - true, if the application model's session lifetime is
- - shorter than the UserPromptCondition object lifetime
- - BLANKET - false
- If the system supports separately accessible permission management GUI,
- then this function may also return true for SESSION and BLANKET.
- @ return True, if the condition can change.
*/
public boolean isMutable() {
lookForImplementation();
if (realUserPromptCondition!=null) {
return realUserPromptCondition.isMutable();
} else {
// since we don't know what the actual status is, we cannot say
// "the condition cannot change anymore"
return true;
}
}
/**
- Displays the prompt string to
- the user and returns true if the user accepts. Depending on the
- amount of levels the condition is assigned to, the prompt may have
- multiple accept buttons and one of them can be selected by default (see
- default level parameter at {@ link UserPromptCondition#getCondition(Bundle, ConditionInfo)}).
- It must always be possible for the user
- to stop further prompting of this question, even with ONESHOT and SESSION levels.
- In case of BLANKET
- and SESSION levels, it is possible that the user has already answered the question,
- in this case there will be no prompting, but immediate return with the previous answer.
- @ return True if the user accepts the prompt (or accepts any prompt in
- case there are multiple permission levels).
*/
public boolean isSatisfied() {
lookForImplementation();
if (realUserPromptCondition!=null) {
return realUserPromptCondition.isSatisfied();
} else {
// paranoid security option
return false;
}
}
/**
- Checks an array of UserPrompt conditions.
- @ param conds The array containing the UserPrompt conditions to evaluate.
- @ param context Storage area for evaluation. The {@ link org.osgi.service.condpermadmin.ConditionalPermissionAdmin}
- may evaluate a condition several times for one permission check, so this context
- will be used to store results of ONESHOT questions. This way asking the same question
- twice in a row can be avoided. If context is null, temporary results will not be stored.
- @ return True, if all conditions are satisfied.
- @ throws NullPointerException if conds is null.
*/
public boolean isSatisfied(Condition[] conds, Dictionary context) {
lookForImplementation();
if (realUserPromptCondition!=null) {
return realUserPromptCondition.isSatisfied(conds,context);
} else {
// paranoid security option
return false;
throw new RuntimeException("Implementation failed: " + e); } } }

P org.osgi.impl.service.policy

Index: src/org/osgi/impl/service/policy/userprompt/UserPromptActivator.java

RCS file: /cvshome/build/org.osgi.impl.service.policy/src/org/osgi/impl/service/policy/userprompt/UserPromptActivator.java,v retrieving revision 1.1 diff -u -r1.1 UserPromptActivator.java --- src/org/osgi/impl/service/policy/userprompt/UserPromptActivator.java 9 May 2005 21:39:12 -0000 1.1 +++ src/org/osgi/impl/service/policy/userprompt/UserPromptActivator.java 7 Jul 2006 07:28:51 -0000 @ @ -22,12 +22,12 @ @

public class UserPromptActivator implements BundleActivator { public void start(BundleContext context) throws Exception {
UserPromptCondition.setContext(context);
UserPromptCondition.registerMySelf();
UserPromptConditionImpl.setContext(context);
UserPromptConditionImpl.registerMySelf(); }

public void stop(BundleContext context) throws Exception {
UserPromptCondition.deregisterMySelf();
UserPromptConditionImpl.deregisterMySelf(); }

} Index: src/org/osgi/impl/service/policy/userprompt/UserPromptCondition.java

RCS file: src/org/osgi/impl/service/policy/userprompt/UserPromptCondition.java diff -N src/org/osgi/impl/service/policy/userprompt/UserPromptCondition.java --- src/org/osgi/impl/service/policy/userprompt/UserPromptCondition.java 7 Mar 2006 11:05:05 -0000 1.17 +++ /dev/null 1 Jan 1970 00:00:00 -0000 @ @ -1,430 +0,0 @ @ -/*
- ============================================================================
- This material, including documentation and any related computer programs,
- is protected by copyright controlled by Nokia and its licensors.
- All rights are reserved.
- These materials have been contributed to the Open Services Gateway
- Initiative (OSGi)as "MEMBER LICENSED MATERIALS" as defined in, and subject
- to the terms of, the OSGi Member Agreement specifically including, but not
- limited to, the license rights and warranty disclaimers as set forth in
- Sections 3.2 and 12.1 thereof, and the applicable Statement of Work.
- All company, brand and product names contained within this document may be
- trademarks that are the sole property of the respective owners.
- The above notice must be included on all copies of this document.
- ============================================================================
*/
-package org.osgi.impl.service.policy.userprompt;
-import java.io.BufferedReader; -import java.io.File; -import java.io.FileInputStream; -import java.io.FileNotFoundException; -import java.io.FileOutputStream; -import java.io.IOException; -import java.io.InputStreamReader; -import java.io.ObjectInputStream; -import java.io.ObjectOutputStream; -import java.io.Serializable; -import java.io.StreamCorruptedException; -import java.util.ArrayList; -import java.util.Dictionary; -import java.util.HashMap; -import java.util.Hashtable; -import java.util.Iterator; -import java.util.List; -import java.util.ResourceBundle;
-import org.osgi.framework.Bundle; -import org.osgi.framework.BundleContext; -import org.osgi.service.condpermadmin.Condition;
-/**
*
- Basic console userprompt implementation.
- @ version $Revision: 1.17 $
*/ -public class UserPromptCondition
extends org.osgi.util.mobile.UserPromptCondition
implements Serializable -{
/**
- Comment for serialVersionUID
*/
private static final long serialVersionUID = 3834593218389226802L;
private static BundleContext context;
public static String ONESHOT_STRING = "ONESHOT";
public static String SESSION_STRING = "SESSION";
public static String BLANKET_STRING = "BLANKET";
public static String NEVER_STRING = "NEVER";
public static String NOSESSION_STRING = "NOSESSION";
/**
- All userprompt conditions are stored here, so that there are no duplicates.
- The keys are strings as given by generateUniqueID, the values are the conditions themselves.
*/
static HashMap conditions;
final long bundleID;
final String catalogName;
final String message;
final String defaultLevel;
final String levels;
final boolean oneshotAllowed;
final boolean sessionAllowed;
final boolean blanketAllowed;
/**
- What is the choice the user made last time. Possible values "SESSION", "BLANKET", "NEVER",
- or null, meaning there has been no choice yet. "ONESHOT" is not included, since even
- if the user said yes to it, it has no consequence on subsequent prompts.
*/
String status = null;
/**
- Create an identifier to use as storage key for a userprompt condition
- @ param bundle
- @ param catalogName
- @ param message
- @ return
*/
static String generateUniqueID(Bundle bundle,String catalogName,String message) {
return ""+bundle.getBundleId()+"|"+catalogName+"|"+message;
}
public boolean isPostponed() {
return status==null;
}
public boolean isMutable() {
return status==null;
// Our implementation doesn't have a separate management interface for setting permissions,
// so once the user chose for example "blanket", it will always stay that way.
}
private String getLocalizedMessage() {
String localizedMessage;
if (message.startsWith("%")) {
String messageID = message.substring(1);
ResourceBundle resourceBundle = ResourceBundle.getBundle(catalogName);
localizedMessage = resourceBundle.getString(messageID);
if (localizedMessage==null) { // fall back
localizedMessage = messageID;
}
} else {
localizedMessage = message;
}
return localizedMessage;
}
private List getPossibleAnswers() {
ArrayList al = new ArrayList(5);
if (blanketAllowed) {
al.add("always");
}
if (sessionAllowed) {
al.add("session");
al.add("nosession");
}
if (oneshotAllowed) {
al.add("yes");
al.add("no");
}
al.add("never");
return al;
}
public boolean isSatisfied() {
if (status!=null) {
if (status.equals(BLANKET_STRING)||status.equals(SESSION_STRING)) return true;
if (status.equals(NEVER_STRING)||status.equals(NOSESSION_STRING)) return false;
}
System.out.println("User Question:");
System.out.println(getLocalizedMessage());
List possibleAnswers = getPossibleAnswers();
System.out.println(possibleAnswers.toString());
BufferedReader reader = new BufferedReader(new InputStreamReader(System.in));
String answer = null;
while (answer==null) {
try {
answer = reader.readLine();
}
catch (IOException e) {
// TODO do log and whatever
e.printStackTrace();
return false;
}
if (possibleAnswers.contains(answer)) break;
answer = null;
}
return setAnswer(answer);
}
/**
- figures out from a user answer, whether the isSatisfied() method should return
- true or false
- @ param answer
- @ return
*/
boolean setAnswer(String answer) {
// so we have an answer
boolean satisfied;
if (answer.equals("always")) {
status = BLANKET_STRING;
satisfied = true;
} else if (answer.equals("session")) {
status = SESSION_STRING;
satisfied = true;
} else if (answer.equals("never")) {
status = NEVER_STRING;
satisfied = false;
} else if (answer.equals("nosession")) {
status = NOSESSION_STRING;
satisfied = false;
} else if (answer.equals("yes")) {
satisfied = true;
} else if (answer.equals("no")) {
satisfied = false;
} else
throw new IllegalStateException("todo");
saveToStorage();
return satisfied;
}
public boolean isSatisfied(Condition[] conds, Dictionary context) {
if (context==null) context = new Hashtable();
String[] questions = new String[conds.length];
Bundle[] bundles = new Bundle[conds.length];
List[] possibleAnswers = new List[conds.length];
// first, figure out what to prompt
for(int i=0;i<conds.length;i++) {
org.osgi.util.mobile.UserPromptCondition ucond = (org.osgi.util.mobile.UserPromptCondition) conds[i];
UserPromptCondition cond = (UserPromptCondition) org.osgi.util.mobile.UserPromptCondition.unWrap(ucond);
Boolean prevAns = (Boolean) context.get(cond);
if ((prevAns!=null)||!cond.isPostponed()) {
if ((prevAns!=null)) {
if (!prevAns.booleanValue()) return false;
} else {
if (!cond.isSatisfied()) return false; // no need to do anything
}
// remove this from every array, it has been asked already
Condition[] c2 = new Condition[conds.length-1];
System.arraycopy(conds,0,c2,0,i);
System.arraycopy(conds,i+i,c2,i,conds.length-1-i);
conds = c2;
i--;
continue;
}
questions[i]=cond.getLocalizedMessage();
bundles[i]=UserPromptCondition.context.getBundle(cond.bundleID);
possibleAnswers[i] = cond.getPossibleAnswers();
}
if (conds.length==0) { return true; }
String[] answers = new String[conds.length];
// then, do the questions
System.out.println("User Question (answer with comma-separated list):");
for(int i=0;i<conds.length;i++) {
System.out.print("("+(i+1)+") ");
System.out.print(bundles[i].getSymbolicName()+": ");
System.out.print(questions[i]);
System.out.print(" ");
System.out.println(possibleAnswers[i]);
}
BufferedReader reader = new BufferedReader(new InputStreamReader(System.in));
String answer = null;
while (answer==null) {
try {
answer = reader.readLine();
}
catch (IOException e) {
// TODO do log and whatever
e.printStackTrace();
return false;
}
answers = Splitter.split(answer,',',-1);
if (answers.length!=conds.length) {
System.err.println("You must answer all "+conds.length+" questions once, with a comma-separated list, no spaces");
answer = null;
continue;
}
for(int i=0;i<answers.length;i++) {
if (!possibleAnswers[i].contains(answers[i])) {
System.err.println("Answer nr. "+i+" \""+answers[i]+"\" is not valid");
answer = null;
continue;
}
}
break;
}
// then evaluate all of them, and return whether all are satisfied
boolean all_satisfied = true;
for(int i=0;i<conds.length;i++) {
org.osgi.util.mobile.UserPromptCondition ucond = (org.osgi.util.mobile.UserPromptCondition) conds[i];
UserPromptCondition cond = (UserPromptCondition) org.osgi.util.mobile.UserPromptCondition.unWrap(ucond);
boolean satisfied = cond.setAnswer(answers[i]);
context.put(cond,satisfied?Boolean.TRUE:Boolean.FALSE);
all_satisfied&=satisfied;
}
return all_satisfied;
}
static void checkConstructorParams(String levels,String defaultLevel) {
levels=levels.toUpperCase();
defaultLevel=defaultLevel.toUpperCase();
if (levels.equals("")) {
throw new IllegalArgumentException("Userprompt levels is empty string");
}
boolean oneshot = false;
boolean session = false;
boolean blanket = false;
String[] alevels = Splitter.split(levels,',',-1);
for(int i=0;i<alevels.length;i++) {
if (alevels[i].equals(ONESHOT_STRING)) { oneshot = true; }
else if (alevels[i].equals(SESSION_STRING)) { session = true; }
else if (alevels[i].equals(BLANKET_STRING)) { blanket = true; }
else throw new IllegalArgumentException("Unknown userprompt level: "+alevels[i]);
}
if (!defaultLevel.equals("") &&
!defaultLevel.equals(ONESHOT_STRING)&&
!defaultLevel.equals(SESSION_STRING)&&
!defaultLevel.equals(BLANKET_STRING))
{
throw new IllegalArgumentException("Unknown default userprompt level: "+defaultLevel);
}
if ((!oneshot && defaultLevel.equals(ONESHOT_STRING)) ||
(!session && defaultLevel.equals(SESSION_STRING)) ||
(!blanket && defaultLevel.equals(BLANKET_STRING)))
{
throw new IllegalArgumentException("Default userprompt level is not among possible levels: "+defaultLevel);
}
}
protected UserPromptCondition(Bundle bundle, String levels, String defaultLevel, String catalogName, String message) {
levels=levels.toUpperCase();
defaultLevel=defaultLevel.toUpperCase();
this.bundleID = bundle.getBundleId();
this.catalogName = catalogName;
this.message = message;
this.defaultLevel = defaultLevel;
this.levels = levels;
if (levels.equals("")) {
throw new IllegalArgumentException("Userprompt levels is empty string");
}
boolean oneshot = false;
boolean session = false;
boolean blanket = false;
String[] alevels = Splitter.split(levels,',',-1);
for(int i=0;i<alevels.length;i++) {
if (alevels[i].equals(ONESHOT_STRING)) { oneshot = true; }
else if (alevels[i].equals(SESSION_STRING)) { session = true; }
else if (alevels[i].equals(BLANKET_STRING)) { blanket = true; }
else throw new IllegalArgumentException("Unknown userprompt level: "+alevels[i]);
}
oneshotAllowed = oneshot;
sessionAllowed = session;
blanketAllowed = blanket;
if (!defaultLevel.equals("") &&
!defaultLevel.equals(ONESHOT_STRING)&&
!defaultLevel.equals(SESSION_STRING)&&
!defaultLevel.equals(BLANKET_STRING))
{
throw new IllegalArgumentException("Unknown default userprompt level: "+defaultLevel);
}
if ((!oneshotAllowed && defaultLevel.equals(ONESHOT_STRING)) ||
(!sessionAllowed && defaultLevel.equals(SESSION_STRING)) ||
(!blanketAllowed && defaultLevel.equals(BLANKET_STRING)))
{
throw new IllegalArgumentException("Default userprompt level is not among possible levels: "+defaultLevel);
}
}
public static class Factory implements org.osgi.util.mobile.UserPromptCondition.UserPromptConditionFactory {
public org.osgi.util.mobile.UserPromptCondition getInstance(Bundle bundle, String levels, String defaultLevel, String catalogName, String message) {
checkConstructorParams(levels,defaultLevel);
String id = generateUniqueID(bundle,catalogName,message);
UserPromptCondition condition = (UserPromptCondition) conditions.get(id);
if (condition==null) {
condition = new UserPromptCondition(bundle,levels,defaultLevel,catalogName,message);
conditions.put(id,condition);
}
return condition;
}
}
public static void setContext(BundleContext context) {
UserPromptCondition.context = context;
}
public static void saveToStorage() {
// TODO: this is a rather unsophisticated method....
File stateFile = context.getDataFile("state");
try {
ObjectOutputStream oos = new ObjectOutputStream(new FileOutputStream(stateFile));
oos.writeObject(conditions);
oos.close();
}
catch (FileNotFoundException e) {
// TODO Auto-generated catch block
e.printStackTrace();
return;
}
catch (IOException e) {
// TODO Auto-generated catch block
e.printStackTrace();
return;
}
}
public static void deregisterMySelf() {
conditions = null;
org.osgi.util.mobile.UserPromptCondition.setFactory(null);
}
public static void registerMySelf() throws StreamCorruptedException, IOException, ClassNotFoundException {
File stateFile = context.getDataFile("state");
try {
ObjectInputStream ois = new ObjectInputStream(new FileInputStream(stateFile));
conditions = (HashMap) ois.readObject();
} catch (FileNotFoundException e) {
conditions = new HashMap();
}
// this counts as a new session, so we have to delete every "session" permission
for(Iterator i = conditions.values().iterator();i.hasNext();) {
UserPromptCondition cond = (UserPromptCondition) i.next();
if (SESSION_STRING.equals(cond.status)) cond.status = null;
if (NOSESSION_STRING.equals(cond.status)) cond.status = null;
}
org.osgi.util.mobile.UserPromptCondition.setFactory(new Factory());
}
public boolean equals(Object var0) {
return this==var0;
}
-} Index: build.properties

RCS file: /cvshome/build/org.osgi.impl.service.policy/build.properties,v retrieving revision 1.12 diff -u -r1.12 build.properties --- build.properties 9 May 2005 21:39:12 -0000 1.12 +++ build.properties 7 Jul 2006 07:28:51 -0000 @ @ -1,3 +1,3 @ @ bin.includes = ${p}.jar jars.compile.order = ${p}.jar -expand.${p}.jar = ${p}, ${p}.permadmin, ${p}.util, ${p}.dmtprincipal, ${p}.condpermadmin, ${p}.userprompt, OSGI-INF.doc, OSGI-INF +expand.${p}.jar = ${p}, ${p}.permadmin, ${p}.util, ${p}.dmtprincipal, ${p}.condpermadmin, [${p}.userprompt], OSGI-INF.doc, OSGI-INF Index: .classpath

RCS file: /cvshome/build/org.osgi.impl.service.policy/.classpath,v retrieving revision 1.12 diff -u -r1.12 .classpath --- .classpath 11 May 2006 03:12:52 -0000 1.12 +++ .classpath 7 Jul 2006 07:28:51 -0000 @ @ -1,8 +1,9 @ @ <?xml version="1.0" encoding="UTF-8"?>
Index: src/org/osgi/impl/service/policy/userprompt/UserPromptConditionImpl.java

RCS file: src/org/osgi/impl/service/policy/userprompt/UserPromptConditionImpl.java diff -N src/org/osgi/impl/service/policy/userprompt/UserPromptConditionImpl.java --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ src/org/osgi/impl/service/policy/userprompt/UserPromptConditionImpl.java 1 Jan 1970 00:00:00 -0000 @ @ -0,0 +1,408 @ @ +/*
- ============================================================================
- This material, including documentation and any related computer programs,
- is protected by copyright controlled by Nokia and its licensors.
- All rights are reserved.
- These materials have been contributed to the Open Services Gateway
- Initiative (OSGi)as "MEMBER LICENSED MATERIALS" as defined in, and subject
- to the terms of, the OSGi Member Agreement specifically including, but not
- limited to, the license rights and warranty disclaimers as set forth in
- Sections 3.2 and 12.1 thereof, and the applicable Statement of Work.
- All company, brand and product names contained within this document may be
- trademarks that are the sole property of the respective owners.
- The above notice must be included on all copies of this document.
- ============================================================================
*/
+package org.osgi.impl.service.policy.userprompt;
+import java.io.; +import java.util.;
+import org.osgi.framework.; +import org.osgi.service.condpermadmin.;
+/**
- Basic console userprompt implementation.
- @ version $Revision: 1.17 $
*/ +public class UserPromptConditionImpl implements Serializable, Condition {
/**
- Comment for serialVersionUID
*/
private static final long serialVersionUID = 3834593218389226802L;
private static BundleContext context;
public static String ONESHOT_STRING = "ONESHOT";
public static String SESSION_STRING = "SESSION";
public static String BLANKET_STRING = "BLANKET";
public static String NEVER_STRING = "NEVER";
public static String NOSESSION_STRING = "NOSESSION";
/**
- All userprompt conditions are stored here, so that there are no
- duplicates. The keys are strings as given by generateUniqueID, the values
- are the conditions themselves.
*/
static HashMap conditions;
final long bundleID;
final String catalogName;
final String message;
final String defaultLevel;
final String levels;
final boolean oneshotAllowed;
final boolean sessionAllowed;
final boolean blanketAllowed;
/**
- What is the choice the user made last time. Possible values "SESSION",
- "BLANKET", "NEVER", or null, meaning there has been no choice yet.
- "ONESHOT" is not included, since even if the user said yes to it, it has
- no consequence on subsequent prompts.
*/
String status = null;
/**
- Create an identifier to use as storage key for a userprompt condition
- @ param bundle
- @ param catalogName
- @ param message
- @ return
*/
static String generateUniqueID(Bundle bundle, String catalogName,
String message) {
return "" + bundle.getBundleId() + "|" + catalogName + "|" + message;
}
public boolean isPostponed() {
return status == null;
}
public boolean isMutable() {
return status == null;
// Our implementation doesn't have a separate management interface for
// setting permissions,
// so once the user chose for example "blanket", it will always stay
// that way.
}
private String getLocalizedMessage() {
String localizedMessage;
if (message.startsWith("%")) {
String messageID = message.substring(1);
ResourceBundle resourceBundle = ResourceBundle
.getBundle(catalogName);
localizedMessage = resourceBundle.getString(messageID);
if (localizedMessage == null) { // fall back
localizedMessage = messageID;
}
}
else {
localizedMessage = message;
}
return localizedMessage;
}
private List getPossibleAnswers() {
ArrayList al = new ArrayList(5);
if (blanketAllowed) {
al.add("always");
}
if (sessionAllowed) {
al.add("session");
al.add("nosession");
}
if (oneshotAllowed) {
al.add("yes");
al.add("no");
}
al.add("never");
return al;
}
public boolean isSatisfied() {
if (status != null) {
if (status.equals(BLANKET_STRING) || status.equals(SESSION_STRING))
return true;
if (status.equals(NEVER_STRING) || status.equals(NOSESSION_STRING))
return false;
}
System.out.println("User Question:");
System.out.println(getLocalizedMessage());
List possibleAnswers = getPossibleAnswers();
System.out.println(possibleAnswers.toString());
BufferedReader reader = new BufferedReader(new InputStreamReader(
System.in));
String answer = null;
while (answer == null) {
try {
answer = reader.readLine();
}
catch (IOException e) {
// TODO do log and whatever
e.printStackTrace();
return false;
}
if (possibleAnswers.contains(answer))
break;
answer = null;
}
return setAnswer(answer);
}
/**
- figures out from a user answer, whether the isSatisfied() method should
- return true or false
- @ param answer
- @ return
*/
boolean setAnswer(String answer) {
// so we have an answer
boolean satisfied;
if (answer.equals("always")) {
status = BLANKET_STRING;
satisfied = true;
}
else if (answer.equals("session")) {
status = SESSION_STRING;
satisfied = true;
}
else if (answer.equals("never")) {
status = NEVER_STRING;
satisfied = false;
}
else if (answer.equals("nosession")) {
status = NOSESSION_STRING;
satisfied = false;
}
else if (answer.equals("yes")) {
satisfied = true;
}
else if (answer.equals("no")) {
satisfied = false;
}
else
throw new IllegalStateException("todo");
saveToStorage();
return satisfied;
}
public boolean isSatisfied(Condition[] conds, Dictionary context) {
if (context == null)
context = new Hashtable();
String[] questions = new String[conds.length];
Bundle[] bundles = new Bundle[conds.length];
List[] possibleAnswers = new List[conds.length];
// first, figure out what to prompt
for (int i = 0; i < conds.length; i++) {
UserPromptConditionImpl cond = (UserPromptConditionImpl) conds[i];
Boolean prevAns = (Boolean) context.get(cond);
if ((prevAns != null) || !cond.isPostponed()) {
if ((prevAns != null)) {
if (!prevAns.booleanValue())
return false;
}
else {
if (!cond.isSatisfied())
return false; // no need to do anything
}
// remove this from every array, it has been asked already
Condition[] c2 = new Condition[conds.length - 1];
System.arraycopy(conds, 0, c2, 0, i);
System.arraycopy(conds, i + i, c2, i, conds.length - 1 - i);
conds = c2;
i--;
continue;
}
questions[i] = cond.getLocalizedMessage();
bundles[i] = UserPromptConditionImpl.context.getBundle(cond.bundleID);
possibleAnswers[i] = cond.getPossibleAnswers();
}
if (conds.length == 0) {
return true;
}
String[] answers = new String[conds.length];
// then, do the questions
System.out.println("User Question (answer with comma-separated list):");
for (int i = 0; i < conds.length; i++) {
System.out.print("(" + (i + 1) + ") ");
System.out.print(bundles[i].getSymbolicName() + ": ");
System.out.print(questions[i]);
System.out.print(" ");
System.out.println(possibleAnswers[i]);
}
BufferedReader reader = new BufferedReader(new InputStreamReader(
System.in));
String answer = null;
while (answer == null) {
try {
answer = reader.readLine();
}
catch (IOException e) {
// TODO do log and whatever
e.printStackTrace();
return false;
}
answers = Splitter.split(answer, ',', -1);
if (answers.length != conds.length) {
System.err
.println("You must answer all "
- conds.length
- " questions once, with a comma-separated list, no spaces");
answer = null;
continue;
}
for (int i = 0; i < answers.length; i++) {
if (!possibleAnswers[i].contains(answers[i])) {
System.err.println("Answer nr. " + i + " \"" + answers[i]
- "\" is not valid");
answer = null;
continue;
}
}
break;
}
// then evaluate all of them, and return whether all are satisfied
boolean all_satisfied = true;
for (int i = 0; i < conds.length; i++) {
UserPromptConditionImpl cond = (UserPromptConditionImpl) conds[i];
boolean satisfied = cond.setAnswer(answers[i]);
context.put(cond, satisfied ? Boolean.TRUE : Boolean.FALSE);
all_satisfied &= satisfied;
}
return all_satisfied;
}
UserPromptConditionImpl(Bundle bundle, ConditionInfo info) {
String[] args = info.getArgs();
if (args.length != 4)
throw new IllegalArgumentException("args.length==" + args.length
- " (should be 4)");
if ( args[0]==null || args[1]==null || args[2]==null || args[3]==null)
throw new IllegalArgumentException("One of the arguments is null");
levels = args[0].toUpperCase();
defaultLevel = args[1].toUpperCase();
catalogName = args[2];
message = args[3];
this.bundleID = bundle.getBundleId();
if (levels.equals("")) {
throw new IllegalArgumentException(
"Userprompt levels is empty string");
}
boolean oneshot = false;
boolean session = false;
boolean blanket = false;
String[] alevels = Splitter.split(levels, ',', -1);
for (int i = 0; i < alevels.length; i++) {
if (alevels[i].equals(ONESHOT_STRING)) {
oneshot = true;
}
else if (alevels[i].equals(SESSION_STRING)) {
session = true;
}
else if (alevels[i].equals(BLANKET_STRING)) {
blanket = true;
}
else
throw new IllegalArgumentException("Unknown userprompt level: "
- alevels[i]);
}
oneshotAllowed = oneshot;
sessionAllowed = session;
blanketAllowed = blanket;
if (!defaultLevel.equals("") && !defaultLevel.equals(ONESHOT_STRING)
&& !defaultLevel.equals(SESSION_STRING)
&& !defaultLevel.equals(BLANKET_STRING)) {
throw new IllegalArgumentException(
"Unknown default userprompt level: " + defaultLevel);
}
if ((!oneshotAllowed && defaultLevel.equals(ONESHOT_STRING))
|| (!sessionAllowed && defaultLevel.equals(SESSION_STRING))
|| (!blanketAllowed && defaultLevel.equals(BLANKET_STRING))) {
throw new IllegalArgumentException(
"Default userprompt level is not among possible levels: "
- defaultLevel);
}
}
public static void setContext(BundleContext context) {
UserPromptConditionImpl.context = context;
}
public static void saveToStorage() {
// TODO: this is a rather unsophisticated method....
File stateFile = context.getDataFile("state");
try {
ObjectOutputStream oos = new ObjectOutputStream(
new FileOutputStream(stateFile));
oos.writeObject(conditions);
oos.close();
}
catch (FileNotFoundException e) {
// TODO Auto-generated catch block
e.printStackTrace();
return;
}
catch (IOException e) {
// TODO Auto-generated catch block
e.printStackTrace();
return;
}
}
public static void deregisterMySelf() {
conditions = null;
}
public static void registerMySelf() throws StreamCorruptedException,
IOException, ClassNotFoundException {
File stateFile = context.getDataFile("state");
try {
ObjectInputStream ois = new ObjectInputStream(new FileInputStream(
stateFile));
conditions = (HashMap) ois.readObject();
ois.close();
}
catch (FileNotFoundException e) {
conditions = new HashMap();
}
// this counts as a new session, so we have to delete every "session"
// permission
for (Iterator i = conditions.values().iterator(); i.hasNext();) {
UserPromptConditionImpl cond = (UserPromptConditionImpl) i.next();
if (SESSION_STRING.equals(cond.status))
cond.status = null;
if (NOSESSION_STRING.equals(cond.status))
cond.status = null;
}
}
public static Condition getCondition(Bundle bundle, ConditionInfo info ) {
return new UserPromptConditionImpl(bundle,info);
} +}

osgi / bugzilla-archive

UserPromptCondition.UserPromptConditionFactory must be removed #303

Eclipse Workspace Patch 1.0

P org.osgi.test.cases.policy

Index: src/org/osgi/test/cases/policy/tbc/UserPromptCondition/GetCondition.java

P org.osgi.util.mobile

Index: src/org/osgi/util/mobile/UserPromptCondition.java

P org.osgi.impl.service.policy

Index: src/org/osgi/impl/service/policy/userprompt/UserPromptActivator.java

} Index: src/org/osgi/impl/service/policy/userprompt/UserPromptCondition.java

-} Index: build.properties

Index: src/org/osgi/impl/service/policy/userprompt/UserPromptConditionImpl.java