| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../javadoc.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>// ***************************************************************************************************************************<a name="line.1"></a> |
| <span class="sourceLineNo">002</span>// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *<a name="line.2"></a> |
| <span class="sourceLineNo">003</span>// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *<a name="line.3"></a> |
| <span class="sourceLineNo">004</span>// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance *<a name="line.4"></a> |
| <span class="sourceLineNo">005</span>// * with the License. You may obtain a copy of the License at *<a name="line.5"></a> |
| <span class="sourceLineNo">006</span>// * *<a name="line.6"></a> |
| <span class="sourceLineNo">007</span>// * http://www.apache.org/licenses/LICENSE-2.0 *<a name="line.7"></a> |
| <span class="sourceLineNo">008</span>// * *<a name="line.8"></a> |
| <span class="sourceLineNo">009</span>// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an *<a name="line.9"></a> |
| <span class="sourceLineNo">010</span>// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *<a name="line.10"></a> |
| <span class="sourceLineNo">011</span>// * specific language governing permissions and limitations under the License. *<a name="line.11"></a> |
| <span class="sourceLineNo">012</span>// ***************************************************************************************************************************<a name="line.12"></a> |
| <span class="sourceLineNo">013</span>package org.apache.juneau.transform;<a name="line.13"></a> |
| <span class="sourceLineNo">014</span><a name="line.14"></a> |
| <span class="sourceLineNo">015</span>/**<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * Bean interceptor.<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> *<a name="line.17"></a> |
| <span class="sourceLineNo">018</span> * <p><a name="line.18"></a> |
| <span class="sourceLineNo">019</span> * Bean interceptors intercept calls to bean getters and setters to allow them to override values in transit.<a name="line.19"></a> |
| <span class="sourceLineNo">020</span> *<a name="line.20"></a> |
| <span class="sourceLineNo">021</span> * <h5 class='section'>Example:</h5><a name="line.21"></a> |
| <span class="sourceLineNo">022</span> * <p class='bcode w800'><a name="line.22"></a> |
| <span class="sourceLineNo">023</span> * <jc>// Interceptor that strips out sensitive information on Address beans.</jc><a name="line.23"></a> |
| <span class="sourceLineNo">024</span> * <jk>public class</jk> AddressInterceptor <jk>extends</jk> BeanInterceptor&lt;Address&gt; {<a name="line.24"></a> |
| <span class="sourceLineNo">025</span> *<a name="line.25"></a> |
| <span class="sourceLineNo">026</span> * <ja>@Override</ja><a name="line.26"></a> |
| <span class="sourceLineNo">027</span> * <jk>public</jk> Object readProperty(Address bean, String name, Object value) {<a name="line.27"></a> |
| <span class="sourceLineNo">028</span> * <jk>if</jk> (<js>"taxInfo"</js>.equals(name))<a name="line.28"></a> |
| <span class="sourceLineNo">029</span> * <jk>return</jk> <js>"redacted"</js>;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span> * <jk>return</jk> value;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * }<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> *<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * <ja>@Override</ja><a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * <jk>public</jk> Object writeProperty(Address bean, String name, Object value) {<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * <jk>if</jk> (<js>"taxInfo"</js>.equals(name) &amp;&amp; <js>"redacted"</js>.equals(value))<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * <jk>return</jk> TaxInfoUtils.<jsm>lookup</jsm>(bean.getStreet(), bean.getCity(), bean.getState());<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * <jk>return</jk> value;<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * }<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * }<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * </p><a name="line.40"></a> |
| <span class="sourceLineNo">041</span> *<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * <p><a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * Bean interceptors are registered in the following way:<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * <ul class='javatree'><a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * <li class='ja'>{@link org.apache.juneau.annotation.Bean#interceptor() @Bean(interceptor)}<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * <li class='jm'>{@link org.apache.juneau.BeanContextBuilder#beanInterceptor(Class,Class)}<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * </ul><a name="line.47"></a> |
| <span class="sourceLineNo">048</span> *<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * <h5 class='section'>Example:</h5><a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * <p class='bcode w800'><a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * <jc>// Register interceptor on bean class.</jc><a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * <ja>@Bean</ja>(interceptor=AddressInterceptor.<jk>class</jk>)<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * <jk>public class</jk> Address {<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * <jk>public</jk> String getTaxInfo() {...}<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * <jk>public void</jk> setTaxInfo(String s) {...}<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * }<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * </p><a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * @param <T> The bean type.<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> */<a name="line.59"></a> |
| <span class="sourceLineNo">060</span>public class BeanInterceptor<T> {<a name="line.60"></a> |
| <span class="sourceLineNo">061</span><a name="line.61"></a> |
| <span class="sourceLineNo">062</span> /** Default interceptor */<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> public static class Default extends BeanInterceptor<Object> {}<a name="line.63"></a> |
| <span class="sourceLineNo">064</span><a name="line.64"></a> |
| <span class="sourceLineNo">065</span> /**<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * Default reusable property filter instance.<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> */<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> public static final BeanInterceptor<Object> DEFAULT = new Default();<a name="line.68"></a> |
| <span class="sourceLineNo">069</span><a name="line.69"></a> |
| <span class="sourceLineNo">070</span> /**<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * Property read interceptor.<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> *<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * <p><a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * Subclasses can override this property to convert property values to some other object just before serialization.<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> *<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * <h5 class='section'>Example:</h5><a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * <p class='bcode w800'><a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * <jc>// Address filter that strips out sensitive information.</jc><a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * <jk>public class</jk> AddressInterceptor <jk>extends</jk> BeanInterceptor&lt;Address&gt; {<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> *<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * <jk>public</jk> Object readProperty(Address bean, String name, Object value) {<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * <jk>if</jk> (<js>"taxInfo"</js>.equals(name))<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * <jk>return</jk> <js>"redacted"</js>;<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> * <jk>return</jk> value;<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> * }<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * }<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * </p><a name="line.87"></a> |
| <span class="sourceLineNo">088</span> *<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * @param bean The bean from which the property was read.<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * @param name The property name.<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * @param value The value just extracted from calling the bean getter.<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * @return The value to serialize. Default is just to return the existing value.<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> */<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> public Object readProperty(T bean, String name, Object value) {<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> return value;<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> }<a name="line.96"></a> |
| <span class="sourceLineNo">097</span><a name="line.97"></a> |
| <span class="sourceLineNo">098</span> /**<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> * Property write interceptor.<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> *<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * <p><a name="line.101"></a> |
| <span class="sourceLineNo">102</span> * Subclasses can override this property to convert property values to some other object just before calling the<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> * bean setter.<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> *<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> * <h5 class='section'>Example:</h5><a name="line.105"></a> |
| <span class="sourceLineNo">106</span> * <p class='bcode w800'><a name="line.106"></a> |
| <span class="sourceLineNo">107</span> * <jc>// Address filter that strips out sensitive information.</jc><a name="line.107"></a> |
| <span class="sourceLineNo">108</span> * <jk>public class</jk> AddressInterceptor <jk>extends</jk> BeanInterceptor&lt;Address&gt; {<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> *<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> * <jk>public</jk> Object writeProperty(Address bean, String name, Object value) {<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * <jk>if</jk> (<js>"taxInfo"</js>.equals(name) &amp;&amp; <js>"redacted"</js>.equals(value))<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> * <jk>return</jk> TaxInfoUtils.<jsm>lookup</jsm>(bean.getStreet(), bean.getCity(), bean.getState());<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> * <jk>return</jk> value;<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> * }<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> * }<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> * </p><a name="line.116"></a> |
| <span class="sourceLineNo">117</span> *<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> * @param bean The bean from which the property was read.<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> * @param name The property name.<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> * @param value The value just parsed.<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> * @return The value to serialize. Default is just to return the existing value.<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> */<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> public Object writeProperty(T bean, String name, Object value) {<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> return value;<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> }<a name="line.125"></a> |
| <span class="sourceLineNo">126</span>}<a name="line.126"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
