one-ticket?ticket_id=:id. For a given OID, the
* URL path is determined as follows:
*
* com.arsdigita.persistence.metadata.Property.isComposite()==true
* ).
* :id with values from the given
* OID.
*
* model examples;
* object type Forum extends ACSObject {
* PackageInstance[1..1] packageInstance;
* }
* object type Message extends ACSObject {...}
* association {
* Forum[1..1] forum;
* composite Message[0..n] messages;
* // NOTE: composite means component in PDL
* }
*
* URLService.registerFinder("examples.Forum",
* new GenericURLFinder("index?forum_id=:id"));
* URLService.registerFinder("examples.Message",
* new GenericURLFinder("message?message_id=:id"));
* examples.Forum will
* work because examples.Forum has a packageInstance
* property of type PackageInstance.
*
*
* The finder registered for examples.Message will work
* because examples.Message has a composite role (in this
* case it is the role called forum), and the composite
* object has a packageInstance property of type
* PackageInstance.
*
* @author Oumi Mehrotra
* @version $Id: GenericURLFinder.java 287 2005-02-22 00:29:02Z sskracic $
* @deprecated without replacement. Current code depends solely on old style
* applications using SiteNode and Package / PackageType. Both are no longer
* in use. This class can not provide any useful information anymore (pb 2013-01)
*/
public class GenericURLFinder implements URLFinder {
private String m_base;
private Map m_params;
public GenericURLFinder(String urlEndingPattern) {
m_params = new HashMap();
m_base = parseQueryString(urlEndingPattern, m_params);
// setFormat(urlEndingPattern);
}
public String find(OID oid, String context) throws NoValidURLException {
return find(oid);
}
public String find(OID oid) throws NoValidURLException {
DataObject dobj = SessionManager.getSession().retrieve(oid);
if (dobj==null) {
throw new NoValidURLException("No such data object " + oid);
}
DataObject packageInstanceData =
getPackageInstanceData(dobj);
if (packageInstanceData == null) {
throw new NoValidURLException("Could not find package " +
"instance for " + dobj);
}
PackageInstance pkg = new PackageInstance(packageInstanceData);
SiteNode sn = pkg.getDefaultMountPoint();
if (sn == null) {
throw new NoValidURLException("Could not find site node for " +
"package instance " + pkg);
}
return sn.getURL() + m_base + unparseQueryString(oid);
}
private DataObject getPackageInstanceData(DataObject dobj) {
if (!isACSObject(dobj.getObjectType())) {
// For compatibility, the GenericURLFinder still tries to support
// domain objects that are not ACSObject, using some metadata
// driven guesswork to find a package instance for the object.
return guessPackageInstanceData(dobj);
}
final String queryName =
"com.arsdigita.kernel.PackageInstanceForObject";
DataQuery query = SessionManager.getSession().retrieveQuery(queryName);
query.setParameter("objectID", dobj.get("id"));
DataObject pkgInst = null;
if (query.next()) {
pkgInst = (DataObject) query.get(MDUtil.PACKAGE_INSTANCE);
}
query.close();
return pkgInst;
}
// This is how URLFinder used to work, before the generic container
// hierarchy was introduced for ACSObject. Now, this method is
// never called for an ACSObject. But I've left in the logic that
// deals with ACSObject so that I can switch back and forth between
// the new algorithm and the old algorithm for debugging.
private DataObject guessPackageInstanceData(DataObject dobj) {
ObjectType o = dobj.getObjectType();
if (isACSObject(o)) {
o = getType( (String) dobj.get(ACSObject.OBJECT_TYPE) );
dobj.specialize(o);
}
if (isPackageInstance(o)) {
return dobj;
}
if (MDUtil.hasPackageInstanceRole(o)) {
return (DataObject) dobj.get(MDUtil.PACKAGE_INSTANCE);
}
// recurse to composite.
DataObject composite = getComposite(dobj);
if (composite != null) {
return guessPackageInstanceData(composite);
}
// The object is not a package instance, has no packageInstance role,
// and has no visible required composite role. Therefore we can't
// generically figure out what package instance the object belongs
// to.
return null;
}
private static DataObject getComposite(DataObject dobj) {
Property compositeRole = MDUtil.getCompositeRole(dobj.getObjectType());
if (compositeRole==null) {
return null;
} else {
return (DataObject) dobj.get(compositeRole.getName());
}
}
private static boolean isACSObject(ObjectType type) {
return (type.isSubtypeOf(getType(ACSObject.BASE_DATA_OBJECT_TYPE)));
}
private static boolean isPackageInstance(ObjectType type) {
return (type.isSubtypeOf(getType(PackageInstance.BASE_DATA_OBJECT_TYPE)));
}
private static ObjectType getType(String typeName) {
return SessionManager.getMetadataRoot().getObjectType(typeName);
}
/**
* Copied from com.arsdigita.util.URLRewriter and modified slightly.
**/
private String unparseQueryString(OID oid) {
StringBuffer buf = new StringBuffer(128);
char sep = '?';
Iterator keys = m_params.keySet().iterator();
while (keys.hasNext()) {
String key = (String)keys.next();
Object value = m_params.get(key);
if (value instanceof String[]) {
String[] values = (String[])value;
for (int i = 0; i < values.length; i++) {
if (values[i] != null) {
appendParam(buf, sep, key, getValue(oid, values[i]));
sep = '&';
}
}
continue;
} else if (value != null) {
appendParam(buf, sep, key, getValue(oid, value.toString()));
sep = '&';
}
}
return buf.toString();
}
private String getValue(OID oid, String val) {
if (val.charAt(0)==':') {
return oid.get(val.substring(1)).toString();
}
return val;
}
//
// COPIED FROM: com.arsdigita.util.URLRewriter
//
private static String parseQueryString(String url, Map params) {
int qmark = url.indexOf('?');
if (qmark < 0) {
return url;
}
String base = url.substring(0, qmark);
String query = url.substring(qmark+1);
params.putAll(HttpUtils.parseQueryString(query));
return base;
}
/**
* Appends string representation of a parameter to the given
* StringBuffer: sep + URLEncode(key) + '=' + URLEncode(value)
**/
private static void appendParam(StringBuffer buf, char sep,
String key, String value) {
buf.append(sep).append(URLEncoder.encode(key))
.append('=').append(URLEncoder.encode(value));
}
}