thoerup/circuitbreaker/CircuitBreaker.java

package dk.thoerup.circuitbreaker;


import dk.thoerup.circuitbreaker.notification.Notifier;
import dk.thoerup.circuitbreaker.notification.NullNotifier;

/* Simple CircuitBreaker implementation - snipped from http://www.jroller.com/kenwdelong/entry/circuit_breaker_in_java
 * 
 *  example of how it can be used

 private CircuitBreaker cb = new CircuitBreaker("test", 5, 10000);
 protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
                class TestInvocation implements CircuitInvocation {
                        String url;
                        public TestInvocation(String url) {
                                this.url = url;
                        }
                        public Object proceed() throws Exception{
                                
                                URL u = new URL(url);
                                URLConnection c = u.openConnection();
                                c.connect();
                                InputStream in = c.getInputStream();
                                in.close();
                                                        
                                
                                return "hello";
                        }
                        
                }
                try {
                        String s = (String) cb.invoke(new TestInvocation("http://rafiki/test"));
                        response.getWriter().print(s);
                } catch (Exception e) {
                        logger.warning( e.getMessage() );
                        response.sendError(500);
                        return;
                }
                
        }
 */


public class CircuitBreaker{
        
        private volatile CircuitBreakerState currentState;
        
        private final OpenState open = new OpenState();
        private final HalfOpenState halfOpen = new HalfOpenState();
        private final ClosedState closed = new ClosedState();
        
        private String name;
        
        private Notifier notifier = new NullNotifier();
        
        public CircuitBreaker(String name, int threshold, long timeoutMS) {
                closed.setThreshold(threshold);
                open.setTimeout(timeoutMS);
                
                this.name = name;
        
                //set correct intial state
                internalReset();
        }
        
        
    public Object invoke(CircuitInvocation invocation) throws Exception
    {
        Object result = null;
        try
        {
            getState().preInvoke(this);
            result = invocation.proceed();
            getState().postInvoke(this);
        }
        catch(Exception e)
        {
            getState().onError(this, e);
            throw e;
        }
        return result;
    }
    
    public void tripBreaker() {
        commonTripBreaker(Notifier.Event.BreakerTripped);
    }
    
        //a re-trip should basically do the same as a normal trip, but it is here just to differentiate the two different events
    public void retripBreaker() {
        commonTripBreaker(Notifier.Event.BreakerRetripped);
    }
    
    private void commonTripBreaker(Notifier.Event event) {
        synchronized(this) {
                if (currentState != open) { // TODO:Is this conditional necessary ??
                        open.trip();
                        currentState = open;
                
                        notifier.sendNotification(name, event);
                }
        }       
    }

    public void attemptReset() {
        synchronized(this) {
                if (currentState != halfOpen) { // TODO:Is this conditional necessary ??
                        currentState = halfOpen;
                        notifier.sendNotification(name, Notifier.Event.BreakerAttemptReset);
                }
        }
        
    }
    
    public void reset() {
        synchronized(this) {
                if (currentState != closed) { // TODO: Is this conditional necessary ??
                        internalReset();
                        notifier.sendNotification(name, Notifier.Event.BreakerReset);
                }
        }
    }
    
    //This one actually sets the correct closed/reset state 
    private void internalReset() {
                closed.resetFailureCount();
                currentState = closed;          
    }
    
    
    private CircuitBreakerState getState() {
        synchronized(this) {
                return currentState;
        }
    }
    
    public boolean isClosed() {
        return (getState() == closed); 
    }
    
    public boolean isOpen() {
        return (getState() == open); 
    }
    
    public String getName() {
        return name;
    }
    
    public String getStateName() {
        return getState().getName();
    }
    
    public int getThreshold() {
        return closed.getThreshold();
    }
    
    public int getTimeout() {
        return (int)open.getTimeout();
    }
    
    public int getFailureCount() {
        if (getState() == closed) {
                return closed.getFailureCount();
        } else {
                return -1;
        }
    }
    
    public long getElapsed() {
        if (getState() == open) {
                return open.getElapsed();
        } else {
                return -1;
        }
    }
    
    public void setNotifier(Notifier notifier) {
        this.notifier = notifier;
    }
    
    public String getNotifierName() {
        return notifier.getClass().getName();
    }
 
}
1	package dk.thoerup.circuitbreaker;
2
3
4	import dk.thoerup.circuitbreaker.notification.Notifier;
5	import dk.thoerup.circuitbreaker.notification.NullNotifier;
6
7	/* Simple CircuitBreaker implementation - snipped from http://www.jroller.com/kenwdelong/entry/circuit_breaker_in_java
8	*
9	* example of how it can be used
10
11	private CircuitBreaker cb = new CircuitBreaker("test", 5, 10000);
12	protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
13	class TestInvocation implements CircuitInvocation {
14	String url;
15	public TestInvocation(String url) {
16	this.url = url;
17	}
18	public Object proceed() throws Exception{
19
20	URL u = new URL(url);
21	URLConnection c = u.openConnection();
22	c.connect();
23	InputStream in = c.getInputStream();
24	in.close();
25
26
27	return "hello";
28	}
29
30	}
31	try {
32	String s = (String) cb.invoke(new TestInvocation("http://rafiki/test"));
33	response.getWriter().print(s);
34	} catch (Exception e) {
35	logger.warning( e.getMessage() );
36	response.sendError(500);
37	return;
38	}
39
40	}
41	*/
42
43
44	public class CircuitBreaker{
45
46	private volatile CircuitBreakerState currentState;
47
48	private final OpenState open = new OpenState();
49	private final HalfOpenState halfOpen = new HalfOpenState();
50	private final ClosedState closed = new ClosedState();
51
52	private String name;
53
54	private Notifier notifier = new NullNotifier();
55
56	public CircuitBreaker(String name, int threshold, long timeoutMS) {
57	closed.setThreshold(threshold);
58	open.setTimeout(timeoutMS);
59
60	this.name = name;
61
62	//set correct intial state
63	internalReset();
64	}
65
66
67	public Object invoke(CircuitInvocation invocation) throws Exception
68	{
69	Object result = null;
70	try
71	{
72	getState().preInvoke(this);
73	result = invocation.proceed();
74	getState().postInvoke(this);
75	}
76	catch(Exception e)
77	{
78	getState().onError(this, e);
79	throw e;
80	}
81	return result;
82	}
83
84	public void tripBreaker() {
85	commonTripBreaker(Notifier.Event.BreakerTripped);
86	}
87
88	//a re-trip should basically do the same as a normal trip, but it is here just to differentiate the two different events
89	public void retripBreaker() {
90	commonTripBreaker(Notifier.Event.BreakerRetripped);
91	}
92
93	private void commonTripBreaker(Notifier.Event event) {
94	synchronized(this) {
95	if (currentState != open) { // TODO:Is this conditional necessary ??
96	open.trip();
97	currentState = open;
98
99	notifier.sendNotification(name, event);
100	}
101	}
102	}
103
104	public void attemptReset() {
105	synchronized(this) {
106	if (currentState != halfOpen) { // TODO:Is this conditional necessary ??
107	currentState = halfOpen;
108	notifier.sendNotification(name, Notifier.Event.BreakerAttemptReset);
109	}
110	}
111
112	}
113
114	public void reset() {
115	synchronized(this) {
116	if (currentState != closed) { // TODO: Is this conditional necessary ??
117	internalReset();
118	notifier.sendNotification(name, Notifier.Event.BreakerReset);
119	}
120	}
121	}
122
123	//This one actually sets the correct closed/reset state
124	private void internalReset() {
125	closed.resetFailureCount();
126	currentState = closed;
127	}
128
129
130	private CircuitBreakerState getState() {
131	synchronized(this) {
132	return currentState;
133	}
134	}
135
136	public boolean isClosed() {
137	return (getState() == closed);
138	}
139
140	public boolean isOpen() {
141	return (getState() == open);
142	}
143
144	public String getName() {
145	return name;
146	}
147
148	public String getStateName() {
149	return getState().getName();
150	}
151
152	public int getThreshold() {
153	return closed.getThreshold();
154	}
155
156	public int getTimeout() {
157	return (int)open.getTimeout();
158	}
159
160	public int getFailureCount() {
161	if (getState() == closed) {
162	return closed.getFailureCount();
163	} else {
164	return -1;
165	}
166	}
167
168	public long getElapsed() {
169	if (getState() == open) {
170	return open.getElapsed();
171	} else {
172	return -1;
173	}
174	}
175
176	public void setNotifier(Notifier notifier) {
177	this.notifier = notifier;
178	}
179
180	public String getNotifierName() {
181	return notifier.getClass().getName();
182	}
183
184	}