org.eclipse.higgins.idas
Interface IContextFactory

Package class diagram package IContextFactory
All Superinterfaces:
IHasMetadata

public interface IContextFactory
extends IHasMetadata

As defined at http://spwiki.editme.com/ContextProvider#ContextFactory, This interface is implemented by IdAS context providers so that their IContext instances may be instantiated.

TODO: Talk about what's required to make this work -- how factories are registered and referenced in the Higgins system.

TODO: Finish commenting methods.


Method Summary
 boolean canCreate(URI contextRef)
          Tests whether the asserted Context Reference can be used by this factory to produce an IContext instance.
 IContext createContext(URI contextRef)
          Using contextRef, creates an instance of IContext and returns it.
 Iterable<URI> getContexts(String filter)
           
 String getName()
           
 String getPolicy()
          Returns the policy in effect for this Context Factory.
 void setPolicy(String policy)
          Sets the policy for for this Context Factory.
 
Methods inherited from interface org.eclipse.higgins.idas.IHasMetadata
addMetadata, createMetadata, getMetadataSet, removeMetadata
 

Method Detail

getName

String getName()
               throws IdASException
Throws:
IdASException

getContexts

Iterable<URI> getContexts(String filter)
                          throws IdASException
Parameters:
filter - Format TBD
Returns:
The set of Context References of Contexts which have been created by this Context Factory
Throws:
IdASException

canCreate

boolean canCreate(URI contextRef)
                  throws IdASException
Tests whether the asserted Context Reference can be used by this factory to produce an IContext instance.

Parameters:
contextRef - URI specifying the Context being tested.
Returns:
true if this factory can produce a context for the passed contextRef
Throws:
IdASException

createContext

IContext createContext(URI contextRef)
                       throws IdASException
Using contextRef, creates an instance of IContext and returns it.

Parameters:
contextRef - URI specifying the Context to create.
Returns:
An IContext instance appropriate for the contextRef.
Throws:
IdASException

getPolicy

String getPolicy()
                 throws IdASException
Returns the policy in effect for this Context Factory.

Returns:
Format is WS-Policy / WS-SecurityPolicy

Throws:
IdASException - TODO: Describe format in more detail. Give examples.

setPolicy

void setPolicy(String policy)
               throws IdASException
Sets the policy for for this Context Factory.

Parameters:
policy - Format is WS-Policy / WS-SecurityPolicy

Throws:
IdASException - TODO: Describe format in more detail. Give examples.


Copyright © 2006 Novell Inc. All Rights Reserved.
This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html

Contributors:
  Jim Sermersheim (Novell, Inc.) - initial API and implementation