raboof/pekko
1
0
Fork 0
Code Issues Pull requests Projects Releases 6 Packages Wiki Activity Actions 11

DOC: Extension sample for application specific settings. See #1702

Browse source 
* Added sample and documentation for how to create extension for application specific config
* Simplified java usage of ExtensionIdProvider, more aligned with how it is done in scala
This commit is contained in:
Patrik Nordwall 2012-01-20 11:30:33 +01:00
parent 642dd9c28a
commit 05d4a6ed38
11 changed files with 345 additions and 119 deletions
Download patch file Download diff file Expand all files Collapse all files

80
akka-docs/java/code/akka/docs/extension/ExtensionDocTestBase.java
View file

@ -9,63 +9,63 @@ import java.util.concurrent.atomic.AtomicLong;
//#imports
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import static org.junit.Assert.*;
public class ExtensionDocTestBase {
//#extension
public static class CountExtensionImpl implements Extension {
//Since this Extension is a shared instance
// per ActorSystem we need to be threadsafe
private final AtomicLong counter = new AtomicLong(0);
//#extension
public static class CountExtensionImpl implements Extension {
//Since this Extension is a shared instance
// per ActorSystem we need to be threadsafe
private final AtomicLong counter = new AtomicLong(0);
//This is the operation this Extension provides
public long increment() {
return counter.incrementAndGet();
}
//This is the operation this Extension provides
public long increment() {
return counter.incrementAndGet();
}
//#extension
}
//#extensionid
static class CountExtensionId extends AbstractExtensionId<CountExtensionImpl> {
//This method will be called by Akka
// to instantiate our Extension
public CountExtensionImpl createExtension(ActorSystemImpl i) {
return new CountExtensionImpl();
}
}
//#extension
//#extensionid
public static class CountExtension extends AbstractExtensionId<CountExtensionImpl> implements ExtensionIdProvider {
//This will be the identifier of our CountExtension
public final static CountExtensionId CountExtension = new CountExtensionId();
//#extensionid
public final static CountExtension instance = new CountExtension();
//#extensionid-provider
static class CountExtensionIdProvider implements ExtensionIdProvider {
public CountExtensionId lookup() {
return CountExtension; //The public static final
}
}
//#extensionid-provider
//#extension-usage-actor
static class MyActor extends UntypedActor {
public void onReceive(Object msg) {
CountExtension.get(getContext().system()).increment();
}
//The lookup method is required by ExtensionIdProvider,
// so we return ourselves here, this allows us
// to configure our extension to be loaded when
// the ActorSystem starts up
public CountExtension lookup() {
return CountExtension.instance; //The public static final
}
//#extension-usage-actor
//This method will be called by Akka
// to instantiate our Extension
public CountExtensionImpl createExtension(ActorSystemImpl system) {
return new CountExtensionImpl();
}
}
@Test public void demonstrateHowToCreateAndUseAnAkkaExtensionInJava() {
//#extensionid
//#extension-usage-actor
public static class MyActor extends UntypedActor {
public void onReceive(Object msg) {
CountExtension.instance.get(getContext().system()).increment();
}
}
//#extension-usage-actor
@Test
public void demonstrateHowToCreateAndUseAnAkkaExtensionInJava() {
final ActorSystem system = null;
try {
//#extension-usage
CountExtension.get(system).increment();
CountExtension.instance.get(system).increment();
//#extension-usage
} catch(Exception e) {
} catch (Exception e) {
//do nothing
}
}